Commit Graph

10637 Commits

Author SHA1 Message Date
Takeshi KOMIYA
5a887b1075 Fix #4828: Allow to override numfig_format partially 2018-04-15 00:23:53 +09:00
Takeshi KOMIYA
19585962a2 Update CHANGES for PR #4834 2018-04-14 21:16:07 +09:00
Takeshi KOMIYA
c0c9a41400
Merge pull request #4834 from lamby/895553-sphinx-please-make-the-set-object-description-reproducible
Ensure set object descriptions are reproducible.
2018-04-14 21:15:19 +09:00
Takeshi KOMIYA
36a8781688 Fix #4803: latex: too slow in proportion to number of auto numbered footnotes 2018-04-14 20:46:01 +09:00
Takeshi KOMIYA
185987a517 Move ShowUrlsTransform to sphinx.builders.latex.transforms 2018-04-14 20:13:16 +09:00
Chris Lamb
0ffc27b7fa Ensure the set object description is reproducible.
Whilst working on the Reproducible Builds effort [0], we noticed
that sphinx could generate output that is not reproducible.

In particular, the rendering of `set` objects in default arguments
and elsewhere is currently non-determinstic. For example:

    class A_Class(object):
        a_set = {'a', 'b', 'c'}

Might be rendered as any of:

     {'a', 'b', 'c'}
     {'a', 'c', 'b'}
     {'b', 'a', 'c'}
     {'b', 'c', 'a'}
     {'c', 'a', 'b'}
     {'c', 'b', 'a'}

Patch attached that sorts the contents of sets whilst rendering.
This is parallel to the `dict` key sorting.

This was originally filed in Debian as #895553 [1].

 [0] https://reproducible-builds.org/
 [1] https://bugs.debian.org/895553

Signed-off-by: Chris Lamb <lamby@debian.org>
2018-04-14 10:30:54 +01:00
Takeshi KOMIYA
0104cba2b8 Convert sphinx.builders.latex to package from module 2018-04-14 18:22:31 +09:00
Chris Lamb
3231676936 Call object_description recursively for dict keys and values. 2018-04-14 10:00:50 +01:00
Gussie Carther
390ea6d35a Fix #4420: Docs conflict on use of rst_prolog and rst_epilog 2018-04-14 17:51:06 +09:00
Takeshi KOMIYA
557514330f Merge branch '1.7' 2018-04-14 15:46:31 +09:00
Takeshi KOMIYA
00bdea2411
Merge pull request #4827 from tk0miya/4784_latex_show_urls_and_substitutions
Fix #4784: latex_show_urls assigns incorrect footnote numbers
2018-04-14 15:44:40 +09:00
Takeshi KOMIYA
af4647c492 Merge branch '1.7' 2018-04-14 15:43:38 +09:00
Takeshi KOMIYA
72762db255
Merge pull request #4839 from tk0miya/mypy-0.590
Fix mypy violations
2018-04-14 15:41:22 +09:00
Takeshi KOMIYA
779d25f7f1 Fix mypy violations 2018-04-14 15:26:53 +09:00
Takeshi KOMIYA
c35eb6fade
Merge pull request #4815 from tk0miya/refine_add_css_file
Refine adding CSS files
2018-04-13 00:21:33 +09:00
Takeshi KOMIYA
c12d616be9
Merge pull request #4819 from TimKam/1428-web-support-wrong-static-param-doc
#1428 update websupport API doc
2018-04-12 23:43:31 +09:00
Takeshi KOMIYA
35e4bd498f
Merge pull request #4831 from tk0miya/fix_docs
Fix docs
2018-04-12 23:42:35 +09:00
Takeshi KOMIYA
3dae6a5024
Merge pull request #4832 from ndevenish/fixdoc
Add missing literalinclude options documentation
2018-04-12 23:41:24 +09:00
Takeshi KOMIYA
5ef8da518f Fix #4784: latex_show_urls assigns incorrect footnote numbers 2018-04-12 23:40:15 +09:00
Nicholas Devenish
5685512e6a Add missing literalinclude options documentation
The start-at and end-at options, added in 560b572 for v1.5a1, #625
weren't previously documented. This fixes that.
2018-04-11 18:10:37 +01:00
Takeshi KOMIYA
69624bffa7 doc: Fix filename 2018-04-12 00:49:31 +09:00
Takeshi KOMIYA
5fd7bd7a12 doc: Fix broken link 2018-04-12 00:49:27 +09:00
Takeshi KOMIYA
5433d5c03d
Merge pull request #4809 from tk0miya/update_classifiers
Update package classifiers
2018-04-11 00:29:48 +09:00
Takeshi KOMIYA
dbafab6a9f
Merge pull request #4823 from tk0miya/4817_fix_URLs
Fix #4817: wrong URLs on warning messages
2018-04-09 10:59:59 +09:00
Takeshi KOMIYA
31d6576871
Merge pull request #4822 from tk0miya/4543_fix_testcase_for_partialmethod
Fix #4543: testcase for partialmethod is failed with py3.6.5
2018-04-09 01:56:27 +09:00
Takeshi KOMIYA
ca8e79a392
Merge branch '1.7' into 4817_fix_URLs 2018-04-09 01:56:12 +09:00
Takeshi KOMIYA
9fb2aa68b9
Merge pull request #4813 from tk0miya/4812_type_annotated_variables
Fix #4812: autodoc ignores type annotated variables
2018-04-09 01:55:18 +09:00
Takeshi KOMIYA
b2bd9f75a6 Merge branch '1.7' 2018-04-09 01:46:00 +09:00
Takeshi KOMIYA
245e7d7bab Fix #4812: autodoc ignores type annotated variables 2018-04-08 23:51:01 +09:00
Takeshi KOMIYA
7e1707000f
Merge pull request #4807 from tk0miya/4783_relpath
Fix #4783: Sphinx crashed when drives of srcdir and outdir are different
2018-04-08 23:35:59 +09:00
Stephen Finucane
651d41e1c7 Mark raw string as such
Resolves the following warning when building docs:

  sphinx/ext/autosummary/__init__.py:94: DeprecationWarning: invalid
  escape sequence \.
    periods_re = re.compile('\.(?:\s+)')

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-04-08 23:35:01 +09:00
Takeshi KOMIYA
1dd605971c
Merge pull request #4804 from tk0miya/add_SphinxDirective
Add SphinxDirective class
2018-04-08 23:30:19 +09:00
Takeshi KOMIYA
b4ccaa4c0b Update comments on conf.py 2018-04-08 22:37:24 +09:00
Takeshi KOMIYA
4546c8a1b1 Fix #4817: wrong URLs on warning messages 2018-04-08 22:32:49 +09:00
Takeshi KOMIYA
aefb3bbaaa Fix #4543: testcase for partialmethod is failed with py3.6.5 2018-04-08 21:54:00 +09:00
Timotheus Kampik
aa5a7e5916 #1428 further indent note 2018-04-08 13:40:23 +02:00
Timotheus Kampik
841a123c39 #1428 move/indent note 2018-04-08 13:38:53 +02:00
Timotheus Kampik
39678b7a61 #1428 update websupport API doc
* ``staticdir`` was not correctly documented
* ```staticroot`` was not correctly documented at all
2018-04-07 17:24:50 +02:00
Takeshi KOMIYA
bd2967f1d2 Add :confval:epub_css_files 2018-04-06 13:11:24 +09:00
Takeshi KOMIYA
5efecd2150 Add :confval:html_css_files 2018-04-06 13:11:24 +09:00
Takeshi KOMIYA
3afc72fba4 Rename add_stylesheet() to add_css_file() 2018-04-06 13:11:24 +09:00
Takeshi KOMIYA
99fbd44e20 Store stylesheets as an instance variable of HTML builder
So far, CSS files are stored as a class variable of HTML builder.
Not to have status globally, this changes it to an instance varable.
2018-04-06 13:10:49 +09:00
Takeshi KOMIYA
c5d6942b88 add_stylesheet() allows additional attributes 2018-04-06 13:10:49 +09:00
jfbu
e81f80880a Slight rework of latex doc 2018-04-02 19:47:57 +02:00
jfbu
5473851e8c Improve formatting of docs about LaTeX builder 2018-04-02 19:23:13 +02:00
Takeshi KOMIYA
3525c5a3b1
Merge pull request #4808 from tk0miya/4789_imgconverter
Fix error handling on imgconverter
2018-04-03 00:33:54 +09:00
Takeshi KOMIYA
7ac8ac643e Fix error handling on imgconverter 2018-04-03 00:14:19 +09:00
Takeshi KOMIYA
cff8dc519b Fix #4783: Sphinx crashed when drives of srcdir and outdir are different 2018-04-02 23:03:02 +09:00
Takeshi KOMIYA
6030e7390d
Merge pull request #4800 from tk0miya/drop_document.settings.gettext_compact
Drop `document.settings.gettext_compact`
2018-04-02 22:58:05 +09:00
Takeshi KOMIYA
5ab403bf36 Define priority for transforms 2018-04-02 22:51:52 +09:00