IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
12,964 Commits 2 Branches 219 Tags 163 MiB
6af3896103
Commit Graph

2646 Commits

Author SHA1 Message Date
Max
61f9005b73 _MockModule and _MockObject now display meaningful names in type annotations and superclass names 2018-09-07 15:14:01 +03:00
Takeshi KOMIYA
35e1764025 Fix #5290: autodoc: failed to analyze source code in egg package 2018-09-06 22:22:01 +09:00
Takeshi KOMIYA
a2d5c79114
Merge branch '1.8' into 4034_fix_download_url2 2018-09-06 02:00:37 +09:00
Takeshi KOMIYA
750e037ce6
Merge pull request #5388 from lamby/reproducbible-frozenset 
Ensure frozen object descriptions are reproducible
 2018-09-06 01:08:32 +09:00
Takeshi KOMIYA
f7e556c1db
Merge pull request #5376 from tk0miya/2401_members_conflicts_with_special_members 
Fix #2401: autodoc: ``:members:`` causes ``:special-members:`` not to be shown
 2018-09-06 00:06:25 +09:00
Chris Lamb
17d32d625b Ensure frozenset object descriptions are 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 `frozenset` objects in default
arguments and elsewhere is currently non-determinstic.

For example:

    frozenset(['a', 'b', 'c'])

Might be rendered as any of:

    frozenset({'a', 'b', 'c'})
    frozenset({'a', 'c', 'b'})
    frozenset({'b', 'a', 'c'})
    frozenset({'b', 'c', 'a'})
    frozenset({'c', 'a', 'b'})
    frozenset({'c', 'b', 'a'})

Patch attached that sorts the contents of frozensets whilst rendering.
This is parallel to the `dict` and `set` type logic

  [0] https://reproducible-builds.org/
 2018-09-05 15:58:54 +01:00
Takeshi KOMIYA
342de4f0fd Merge branch '1.8' 2018-09-05 23:10:20 +09:00
Takeshi KOMIYA
3d35723f6d Merge branch '1.7' into 1.8 2018-09-05 23:09:48 +09:00
Takeshi KOMIYA
abcb5bd5ec The default setting for master_doc is changed to 'index' 2018-09-04 01:14:16 +09:00
Takeshi KOMIYA
06aa1a7864 Fix #2401: autodoc: `:members: causes :special-members:` not to be shown 2018-09-03 01:26:31 +09:00
Takeshi KOMIYA
34cc1b5c95 Fix #2720, #4034: Incorrect links with `:download:`, duplicate names, and parallel builds 2018-09-03 01:01:55 +09:00
Takeshi KOMIYA
a7cab001d9 Drop APIs deprecated in 2.0 2018-09-03 00:31:33 +09:00
Takeshi KOMIYA
219f024595 Add testcase for pygments 2018-09-02 16:17:02 +09:00
Dmitry Shachnev
561199e5e8 Make generated texinfo files reproducible by sorting the anchors 2018-08-30 13:03:49 +03:00
Takeshi KOMIYA
db1582833d
Merge pull request #5346 from tk0miya/add_NodeMatcher 
[Proposal] Add a helper class for Node.traverse()
 2018-08-29 23:49:59 +09:00
Takeshi KOMIYA
63dc6afb62
Merge branch '1.8' into 5348_support_remote_download_file 2018-08-27 01:21:19 +09:00
Takeshi KOMIYA
c5c023cb68
Merge pull request #5352 from tk0miya/improve_pytest_header 
Improve pytest header
 2018-08-27 01:20:42 +09:00
Takeshi KOMIYA
aee5fd04d4 Fix #5348: download reference to remote file is not displayed 2018-08-26 22:25:35 +09:00
Jakob Lykke Andersen
2a544b4ec3 C++, conditionally disable test on sys.maxunicode 2018-08-26 13:17:53 +02:00
Takeshi KOMIYA
9f7afa161e Add NodeMatcher; a helper class for Node.traverse() 2018-08-26 18:14:07 +09:00
Takeshi KOMIYA
48427ae57a Improve pytest header 2018-08-26 11:28:06 +09:00
Takeshi KOMIYA
8eb44a40ab
Merge branch '1.8' into 5321_invalid_lineno_for_i18n_warnings 2018-08-25 11:45:16 +09:00
Takeshi KOMIYA
ea3d0b3768 Merge branch '1.7' into 1.8 2018-08-25 03:07:35 +09:00
Takeshi KOMIYA
520797a5e8 test: Upgrade python on Circle CI to 3.5 2018-08-25 02:53:17 +09:00
Takeshi KOMIYA
328ff6eeae Fix i18n: warnings for translation catalogs have wrong line numbers 2018-08-22 21:01:50 +09:00
Takeshi KOMIYA
59a766d7d6 Fix #5322: autodoc: `Any` typehint causes formatting error 2018-08-22 19:57:27 +09:00
Takeshi KOMIYA
db8865a46d
Merge pull request #5063 from jakobandersen/search_use_dispname 
Search: make a difference between fullname and dispname
 2018-08-20 22:15:03 +09:00
Takeshi KOMIYA
e3f383ad7c
Merge pull request #5315 from tk0miya/add_autodoc_default_options 
Add autodoc_default_options
 2018-08-20 00:26:08 +09:00
Takeshi KOMIYA
7f52ef7512 Merge branch '1.7' 2018-08-19 02:19:06 +09:00
Takeshi KOMIYA
3d9e2cf831 Add autodoc_default_options 2018-08-18 18:22:16 +09:00
Lewis Haley
f196a92055 autodoc: add 'exclude-members' to user global options 
As the previous commit explains, it is now possible to specify arguments
to the global options in config files. This means that we can now include
the `exclude-members` option in this global configuration.

Previously, there was no point including this option because it makes no
sense without arguments. Including this option means users have the
flexibility of explicitly including which special methods they want using
(e.g.):

  :special-members: __init__, __iter__

or explicitly excluding which special-members (or other members) they want
using (e.g.):

  :exclude-members: __weakref__, __hash__
 2018-08-17 16:02:11 +01:00
Lewis Haley
6e1e35c98a autodoc: allow specifying values to global arguments 
Previously, users could specify a *list* of flags in their config files.
The flags were directive names that would otherwise be present in the
.rst files. However, as a list, it was not possible to specify values
to those flags, which *is* possible in .rst files.

For example, in .rst you could say

  :special-members: __init__, __iter__

And this would cause autodoc to generate documents for these methods that
it would otherwise ignore.

This commit changes the config option to instead accept a dictionary.
This is a dictionary whose keys can contain the same flag-names as before,
but whose values can contain the arguments as seen in .rst files.

The old list is still supported, for backwards compatibility, but the data
is transformed into a dictionary when the user's config is loaded.
 2018-08-17 15:51:00 +01:00
Lewis Haley
87029392fd test_autodoc: fix mutable function default argument in do_autodoc 
Setting mutable types as default arguments is bad practice because the
value is only initialised once. This means that defaults arguments of
lists and dictionaries which are modified during code execution *stay*
modified between calls.

In this case, the `options` dictionary accumulated options as more and
more test cases were executed. Without this change, the tests added in
the next commit do not pass.

See: https://stackoverflow.com/questions/1132941/least-astonishment-and-the-mutable-default-argument
 2018-08-17 15:33:58 +01:00
Jakob Lykke Andersen
9cddc344db
Merge pull request #5311 from jakobandersen/cpp_new_delete_expr 
C++, add parsing of new and delete expressions
 2018-08-17 14:33:06 +02:00
Jakob Lykke Andersen
73ae1ac834 C++, add parsing of basic new expressions. 2018-08-17 13:49:44 +02:00
Takeshi KOMIYA
c4fa1aed34 Fix #5211: autodoc: No docs generated for functools.partial functions 2018-08-17 01:24:19 +09:00
Takeshi KOMIYA
11331c5923 Merge branch '1.7' 2018-08-17 00:56:35 +09:00
Takeshi KOMIYA
28131df93e
Merge pull request #5307 from akaihola/5273_doctest_conditional_skip 
Feature: skip doctests conditionally
 2018-08-17 00:33:29 +09:00
Antti Kaihola
098f37fddf Ref #5273: doctest: add test for skipif calling global setup/cleanup 
Ensure that `doctest_global_setup` and `doctest_global_cleanup` are executed
before and after evaluating each `:skipif:` option.
 2018-08-16 17:56:29 +03:00
Antti Kaihola
5ffc924940 Ref #5273: doctest: added a missing final newline 2018-08-16 14:09:06 +03:00
Antti Kaihola
9185c2c356 Ref #5273: doctest: add tests for the :skipif: option 2018-08-16 13:22:59 +03:00
Takeshi KOMIYA
91650d89c9 Fix #5291: autodoc crashed by ForwardRef types 2018-08-15 21:30:49 +09:00
Jakob Lykke Andersen
6433e08069 C++, add parsing of delete expressions. 2018-08-15 10:08:31 +02:00
Takeshi KOMIYA
955c3d388b test Signature annotations in py34 too 2018-08-15 01:22:52 +09:00
Takeshi KOMIYA
e26dc81272 Fix autodoc: Optional types are wrongly rendered 2018-08-15 01:22:52 +09:00
Takeshi KOMIYA
848224f641 Add LaTeXBuilder.context: Build context object by builder 2018-08-13 23:52:44 +09:00
Jakob Lykke Andersen
349890266c C++, parse attributes on declerators as well. 
Fixes sphinx-doc/sphinx#5187
 2018-08-11 16:39:27 +02:00
Jakob Lykke Andersen
ef5448e8bc
Merge pull request #5284 from jakobandersen/cpp_char_lit_5147 
C++, add support for (most) character literals.
 2018-08-10 22:59:22 +02:00
Jakob Lykke Andersen
44127fd13b C++, add support for (most) character literals. 
Fixes sphinx-doc/sphinx#5147
 2018-08-10 22:13:18 +02:00
Terence D. Honles
da45604485 handle NoneType as None 2018-08-10 11:58:08 -07:00
Takeshi KOMIYA
b09c54e669
Merge branch 'master' into graphviz_width_of_svg 2018-08-07 23:16:37 +09:00
Takeshi KOMIYA
b01256dbaf
Merge pull request #5253 from tk0miya/enable_epub_by_default 
Enable epub by default
 2018-08-07 01:05:07 +09:00
Timotheus Kampik
97fd09177c #5258 add tests for highlightText() 2018-08-05 10:45:21 +02:00
Takeshi KOMIYA
7e546c0e0b refactor: Remove duplicated testcase 2018-08-05 08:18:21 +09:00
Takeshi KOMIYA
de73ee5902 refactor: test_autodoc 2018-08-05 08:18:21 +09:00
Takeshi KOMIYA
f591cba27f Fix #5002: graphviz: SVGs do not adapt to the column width 2018-08-05 08:16:46 +09:00
Takeshi KOMIYA
dc4f8d4836 conf.py: Drop epub_author, epub_publisher and epub_copyright 
The default values of them are same as conf.py's. So it is not
needed to override the setting.
 2018-08-05 08:16:00 +09:00
Takeshi KOMIYA
206395121d
Merge pull request #5250 from tk0miya/refactor_math4 
Add :rst:role:`math:numref` role to refer equations (Same as :rst:role:`eq`)
 2018-08-04 21:03:49 +09:00
Takeshi KOMIYA
ec7ee91dd3
Merge pull request #5230 from tk0miya/726_mathjax_config 
#726, #969: Add mathjax_config
 2018-08-04 19:21:01 +09:00
Takeshi KOMIYA
8e56f86383 Add :rst:role:math:numref role to refer equations (Same as :rst:role:eq) 2018-08-02 01:52:40 +09:00
Takeshi KOMIYA
5fd62810b9
Merge pull request #5229 from tk0miya/refactor_latex2 
Check latex_elements at config-inited event
 2018-07-30 23:16:02 +09:00
Takeshi KOMIYA
90246b82b5 Check latex_elements at config-inited event 2018-07-29 22:43:13 +09:00
Takeshi KOMIYA
da7a06b323 WIP: #726, #969: Add mathjax_config 2018-07-29 22:36:53 +09:00
Timotheus Kampik
33d09e1c33
Merge pull request #5207 from TimKam/5186-js-test-infrastructure 
5186 set up JavaScript test infrastructure
 2018-07-29 08:52:37 +02:00
Takeshi KOMIYA
104bd42f51
Merge branch 'master' into refactor_highlighter 2018-07-29 11:21:36 +09:00
Timotheus Kampik
afe46ef74c #5186 add tests for getQueryParameters() 
and fix test description of `urldecode()`
 2018-07-28 21:12:05 +02:00
Takeshi KOMIYA
7ee868fb18 Add testcases for autodoc_default_flags 2018-07-28 22:37:32 +09:00
Takeshi KOMIYA
f969edfaa8 Fix flake8 violations on tests 2018-07-28 20:19:30 +09:00
Takeshi KOMIYA
4165c8dd62
Merge pull request #4988 from tk0miya/refactor_math 
Implement math_renderer framework
 2018-07-28 19:27:55 +09:00
Takeshi KOMIYA
c657f1c1c2 test: Validate whole of generated docs by autodoc 2018-07-28 18:46:13 +09:00
Takeshi KOMIYA
7dad01d18f test: Add do_autodoc() helper 2018-07-28 18:30:27 +09:00
Takeshi KOMIYA
dd65d00f29 Implement math_renderer framework 2018-07-28 18:20:11 +09:00
Takeshi KOMIYA
9bb1e83668
Merge branch 'master' into refactor_highlighter 2018-07-24 01:11:57 +09:00
Takeshi KOMIYA
250e6dbc6c
Merge pull request #5203 from tk0miya/2820_autoclass_supports_nested_class 
Close #2820: autoclass directive supports nested class
 2018-07-23 23:18:31 +09:00
Timotheus Kampik
5fdf81fe2d #5186 configure karma 
and add first karma test
 2018-07-22 12:27:39 +02:00
Antony Lee
732ebb5d1e Capitalization: "Table Of Contents" -> "Table of Contents". 
This is consistent with "Complete Table of Contents" (which is already
in the database), as well as e.g. "Indices and Tables" where "and" is
not capitalized.

This is also fairly standard title-case practice.
 2018-07-22 12:12:48 +02:00
Takeshi KOMIYA
8c29801f27 Close #2820: autoclass directive supports nested class 2018-07-22 01:06:17 +09:00
Takeshi KOMIYA
f3019ee197 Apply :confval:trim_doctest_flags to all builders (cf. text, manpages) 2018-07-21 13:54:51 +09:00
Takeshi KOMIYA
2bafb53179 Add testcase for trim_doctest_flags 2018-07-21 11:46:08 +09:00
Timotheus Kampik
f605012617 #4886 remove obsolete * 2018-07-17 20:40:49 +02:00
Timotheus Kampik
c126067f4e #4886 add tests 
to better cover the current link check ignore configuration
 behavior
 2018-07-16 23:17:44 +02:00
Takeshi KOMIYA
3e57ea0a52 Merge branch '1.7' 2018-07-17 00:37:40 +09:00
Takeshi KOMIYA
922e218214 Fix #5158: autosummary: module summary has been broken when it starts with heading 2018-07-16 18:45:28 +09:00
Takeshi KOMIYA
d3cc565749
Merge branch 'master' into 4976_location_for_logger.info 2018-07-16 17:18:24 +09:00
Jean-François B
82a7a2235f
Merge branch 'master' into latex_xindy 2018-07-16 09:26:23 +02:00
Takeshi KOMIYA
6753b24877
Merge branch '1.7' into 3329_i18n_autosymbol_footnotes 2018-07-16 16:25:55 +09:00
Takeshi KOMIYA
9734bf5a77
Merge pull request #5167 from mitya57/long-tuples 
Fix formatting type annotations for tuples with more than two arguments
 2018-07-16 15:17:17 +09:00
jfbu
3c3dca8203 Fix failed test (changed \sphinxleftcurlybrace) 2018-07-16 01:06:27 +02:00
Takeshi KOMIYA
52bb8e7428
Merge branch '1.7' into 3329_i18n_autosymbol_footnotes 2018-07-15 23:43:09 +09:00
Takeshi KOMIYA
aad56c0361 Fix #3329: i18n: crashed by auto-symbol footnote references 2018-07-15 20:48:39 +09:00
Takeshi KOMIYA
b1acc54cf9 Fix #5139: autodoc: Enum argument missing if it shares value with another 2018-07-15 18:53:53 +09:00
Takeshi KOMIYA
bfe7bb819d Merge branch '1.7' 2018-07-15 14:55:15 +09:00
Dmitry Shachnev
1e11634d51 Add a failing test for formatting Tuple[int, str, int] 2018-07-13 21:21:49 +03:00
Takeshi KOMIYA
a2f6de88c1 Fix #5146: autosummary: warning is emitted when the first line of docstring ends with literal notation 2018-07-08 21:14:01 +09:00
Takeshi KOMIYA
910be1e2a2 Close #4976: `SphinxLoggerAdapter.info() now supports location` parameter 2018-06-26 01:02:37 +09:00
Takeshi KOMIYA
f518d26e45 Merge branch 'master' into 1431_latex_enumlist 2018-06-22 00:27:49 +09:00
Takeshi KOMIYA
3d180f9385 Merge branch '1.7' 2018-06-21 23:23:30 +09:00
jfbu
dbb04d0a33 Obide by Docutils `node['prefix'] and node['suffix']` 2018-06-20 18:11:11 +02:00
Takeshi KOMIYA
2f91a2c22e
Merge branch 'master' into 5035_qthelp_namespace_allows_dashes 2018-06-20 00:45:34 +09:00
Takeshi KOMIYA
d7bf78f3ff Fix #5070: epub: Wrong internal href fragment links 2018-06-19 23:37:37 +09:00
Takeshi KOMIYA
e1a87ba073 Fix broken testcase by alabaster-0.711 2018-06-19 23:36:54 +09:00
Takeshi KOMIYA
b84240d871
Merge pull request #5108 from tk0miya/alabaster-0.711 
Alabaster 0.711
 2018-06-19 23:35:17 +09:00
Takeshi KOMIYA
87ddb6c68f Fix broken testcase by alabaster-0.711 2018-06-19 22:55:05 +09:00
Takeshi KOMIYA
b6904e69af
Merge branch '1.7' into 5091_latex_curlybrace_in_index 2018-06-19 09:46:20 +09:00
Takeshi KOMIYA
58e1067ccd
Merge branch 'master' into 4362_dont_overwrite_latex 2018-06-17 17:50:49 +09:00
Takeshi KOMIYA
af1502c32e
Merge pull request #5084 from tk0miya/3784_mathjax_integrity 
Close #3784: mathjax: Add :confval:`mathjax_options`
 2018-06-17 00:33:58 +09:00
Takeshi KOMIYA
fa3e0ca682 Close #5035: qthelp builder allows dashes in :confval:qthelp_namespace 2018-06-16 18:33:09 +09:00
Takeshi KOMIYA
71c0eb6b1a Merge branch '1.7' 2018-06-16 18:23:36 +09:00
Takeshi KOMIYA
2a9da1d031 Fix #5091: latex: curly braces in index entries are not handled correctly 2018-06-16 01:34:40 +09:00
Takeshi KOMIYA
285ae7e881 Fix #5066: html: "relations" sidebar is not shown by default 2018-06-16 00:51:21 +09:00
Takeshi KOMIYA
28fe6dadf4 Fix #4362: latex: Don't overwrite .tex file if document not changed 2018-06-14 02:14:33 +09:00
Takeshi KOMIYA
34126021d9 Close #3784: mathjax: Add :confval:mathjax_options 2018-06-13 23:24:21 +09:00
Takeshi KOMIYA
6c4d6c3b94 Fix #5032: autodoc loses the first staticmethod parameter for old styled classes 2018-06-13 22:30:14 +09:00
Jakob Lykke Andersen
dd711a7dc7 Search: make a difference between fullname and dispname 2018-06-10 17:16:58 +02:00
Takeshi KOMIYA
0edcae1ff8 Fix #5019: autodoc: crashed by Form Feed Character 2018-06-10 21:08:21 +09:00
Takeshi KOMIYA
72e60ce165 Merge branch '1.7' 2018-06-09 20:53:01 +09:00
Jakob Lykke Andersen
cc026946f7 C++, add support for anon entities. 
Anonymous entities are specified with names starting with "@",
but are rendered as "[anonymous]".

Fixes sphinx-doc/sphinx#3593 and sphinx-doc/sphinx#2683.
 2018-06-09 12:24:34 +02:00
Takeshi KOMIYA
fc7817b854
Merge pull request #5034 from tk0miya/add_html_js_files 
Add :confval:`html_js_files`
 2018-06-09 11:51:11 +09:00
Jean-François B
95a8099913
Merge branch 'master' into latex_remove_shorthandoff_variable 2018-06-08 19:53:46 +02:00
Takeshi KOMIYA
9fc2657d7e Add :confval:html_js_files 2018-06-09 02:38:36 +09:00
Takeshi KOMIYA
9617b138c7
Merge pull request #5049 from tk0miya/4193_canonical_url 
html: Output ``canonical_url`` metadata if :confval:`html_baseurl` set
 2018-06-09 02:35:56 +09:00
jfbu
45c63a8e2d LaTeX, follow-up to PR #5012, avoid label separated by pagebreak 
PR #5012 took care of this for longtable, but the problem can also arise
with tabular/tabulary and is much easier to fix.
 2018-06-08 18:46:15 +02:00
Takeshi KOMIYA
6d5e68b02e
Merge branch '1.7' into 5048_numbered_toctree 2018-06-08 21:41:48 +09:00
Takeshi KOMIYA
5843dcb868
Merge branch '1.7' into 5048_numbered_toctree 2018-06-08 20:52:43 +09:00
jfbu
7bebdd0f97 Add tests for non-captioned table with label in latex 2018-06-08 10:18:53 +02:00
jfbu
b41b1dac5c Deprecate sphinx.writers.latex.ExtBabel.get_shorthandoff() 
This partially reverts d17f3955a5
 2018-06-06 19:16:14 +02:00
Takeshi KOMIYA
fb41dcefab Fix sphinx.testing uses deprecated pytest API; Node.get_marker(name) 2018-06-07 01:22:55 +09:00
Takeshi KOMIYA
96b9b9a127 Fix #5048: crashed with numbered toctree 2018-06-07 00:54:02 +09:00
Takeshi KOMIYA
e30b10a57d html: Output `canonical_url metadata if :confval:html_baseurl` set 2018-06-06 21:18:17 +09:00
jfbu
a32c358342 Remove usage of internal shorthandoff variable from LaTeX writer 2018-06-05 18:38:59 +02:00
jfbu
f9e2a41a48 Merge branch '1.7' 2018-06-05 18:17:18 +02:00
jfbu
66741b1ee9 LaTeX: make deactivation of = and " systematic 
This avoids maintaining list of languages making " (or worse =) active
TeX characters.
 2018-06-05 10:20:17 +02:00
Takeshi KOMIYA
98f10216c7 Merge branch '1.7' 2018-05-29 02:13:54 +09:00
Takeshi KOMIYA
d9df3b4b47
Merge pull request #5005 from tk0miya/3606_load_mathjax_async 
Fix #3606: MathJax should be loaded with async attribute
 2018-05-29 01:04:34 +09:00
Takeshi KOMIYA
1deceda6da
Merge branch 'master' into 3606_load_mathjax_async 2018-05-28 23:04:13 +09:00
Takeshi KOMIYA
af32786af1
Merge branch 'master' into 4983_wrong_id_for_productionlist 2018-05-28 23:00:35 +09:00
Jakob Lykke Andersen
6d52b63eee C++, support for unions. 2018-05-26 20:03:25 +02:00
Jakob Lykke Andersen
f592483156 Add cpp:texpr role (style alternative to cpp:expr) 
Simplified version of sphinx-doc/sphinx#4836,
thanks to mickk-on-cpp.
 2018-05-26 17:25:41 +02:00
jfbu
a08321f962 Better replacement for LaTeX's enumerated list support macros 2018-05-26 15:14:57 +02:00
lucdanton
b839a7cf0e C++: parse pack expansions in function calls. 2018-05-26 13:28:21 +02:00
Takeshi KOMIYA
600c948ff9 Close #1431: latex: Add alphanumeric enumerated list support 2018-05-26 00:19:27 +09:00
shimizukawa
eacaaed1c7 Merge branch 1.7 2018-05-25 08:17:19 +09:00
Takeshi KOMIYA
f3168d9894 Rename app.add_javascript() to add_js_file() 2018-05-24 23:59:49 +09:00
Takeshi KOMIYA
adff7e89d4
Merge branch '1.7' into 4914_dataclasses 2018-05-23 22:37:43 +09:00
Takeshi KOMIYA
51962c715c Merge branch '1.7' 2018-05-23 21:41:45 +09:00
Takeshi KOMIYA
3019558a4f
Merge branch '1.7' into 4919_crashed_by_numbered_toctree 2018-05-23 21:41:38 +09:00
Takeshi KOMIYA
b6ba8cad10 Fix #4648: latex: Now "rubric" elements are rendered as unnumbered section title 2018-05-23 01:22:14 +09:00
Takeshi KOMIYA
0ba5c24f5e Close #4980: latex: Improve label handling of LaTeX builder (section) 2018-05-22 22:06:22 +09:00
Takeshi KOMIYA
1b5e910059 Close #4980: latex: Improve label handling of LaTeX builder (table) 2018-05-22 22:06:22 +09:00
Takeshi KOMIYA
fdc0697690 Close #4980: latex: Improve label handling of LaTeX builder (code-block) 2018-05-22 22:06:22 +09:00
Takeshi KOMIYA
f621fe8533 Close #4980: latex: Improve label handling of LaTeX builder (figure) 2018-05-22 22:06:22 +09:00
Takeshi KOMIYA
d62a274709 Fix #4983: productionlist directive generates invalid IDs for the tokens 2018-05-22 11:17:50 +09:00
jfbu
e7adae9799 Revert extra \relax after \phantomsection in LaTeXTranslator.hypertarget 2018-05-21 16:27:37 +02:00
jfbu
0f2dffb0c8 Avoid unneeded \relax after \phantomsection in glossary item labels 2018-05-21 16:17:58 +02:00
Takeshi KOMIYA
506d4c87ef Merge branch '1.7' 2018-05-21 23:07:54 +09:00
Takeshi KOMIYA
6b20bda67a
Merge branch '1.7' into 4919_crashed_by_numbered_toctree 2018-05-21 23:03:48 +09:00
Takeshi KOMIYA
ff3ac70c76 Fix #4973: latex: glossary directive adds whitespace to each item 2018-05-21 23:01:39 +09:00
Takeshi KOMIYA
3080d24330 Fix #4956: autodoc: Failed to extract document from a subclass of the class on mocked module 2018-05-21 21:53:20 +09:00
Takeshi KOMIYA
cda18f119f Fix #4919: node.asdom() crashes if toctree has :numbered: option 2018-05-21 21:31:34 +09:00
Takeshi KOMIYA
0261b76bcb
Merge branch '1.7' into 4979_latex_index_escaping 2018-05-21 10:40:38 +09:00
Takeshi KOMIYA
be8e2be47b Fix #4914: autodoc: Parsing error when using dataclasses without default values 2018-05-21 00:25:11 +09:00
Takeshi KOMIYA
c09f5e0f98
Merge pull request #4928 from JulienPalard/i18n-ignore-git-dir 
i18n: Ignore dot-directories like .git/ in LC_MESSAGES/.
 2018-05-19 16:44:11 +09:00
Takeshi KOMIYA
ac523c637a
Merge pull request #4975 from tk0miya/refactor_math 
Fix #4333: Enable directives and roles for math by default
 2018-05-19 15:15:38 +09:00
Takeshi KOMIYA
057152e9e7 Merge branch '1.7' 2018-05-19 14:25:23 +09:00
Takeshi KOMIYA
de6f3b252e Fix #4979: latex: Incorrect escaping of curly braces in index entries 2018-05-19 14:15:02 +09:00
Takeshi KOMIYA
4d68b4173b
Merge branch '1.7' into latex_deeply_nested_enumlist 2018-05-19 13:00:00 +09:00
Takeshi KOMIYA
b2abab1c45 Fix #4969: autodoc: constructor method should not have return annotation 2018-05-19 11:49:32 +09:00
Takeshi KOMIYA
adbda06eca Fix make_app() fixture fails to rollback registered roles on creating multiple apps 2018-05-17 00:42:48 +09:00
Takeshi KOMIYA
e675ad2ec9 Enable math_block node rendering by default (without HTML builders) 2018-05-17 00:42:22 +09:00
Takeshi KOMIYA
4e04bff4f5 Enable math node rendering by default (without HTML builders) 
Nowadays, math elements (inline and block level equations) are
integrated into reST spec by default.  But, in Sphinx, they are
not enabled by default.  For this reason, users have to enable
one of math extensions even if target builder supports math
elements directly.

This change starts to enable them by default.  As a first step,
this replaces math node and its structure by docutils based one.
 2018-05-15 22:27:49 +09:00
Takeshi KOMIYA
c6050a3d1e Fix latex: deeply nested enumerated list which is beginning with non-1 causes LaTeX engine crashed 2018-05-15 01:48:12 +09:00
Takeshi KOMIYA
bc19cf72c9 Merge branch '1.7' 2018-05-14 01:04:45 +09:00
Takeshi KOMIYA
e4410b6ab0
Merge branch '1.7' into 4913_literal_block_under_bullet_list 2018-05-12 22:35:55 +09:00
Takeshi KOMIYA
86f179e312
Merge pull request #4941 from tk0miya/4035_rename_viewcode_import 
Rename viewcode_import to viewcode_follow_imported_members (refs: #4035)
 2018-05-12 11:27:17 +09:00
Takayuki SHIMIZUKAWA
79650f5827
fix #4938: i18n doesn't handle node.title correctly (#4939) 2018-05-11 20:51:07 +09:00
Julien Palard
6dcdce685d i18n: Ignore dot-directories like .git/ in LC_MESSAGES/. 
This avoids warnings when find_catalog_source_files returns files
found in .git/ like:

WARNING: Start of line didn't match any expected keyword./refs/heads/freezed-library/colorsys.mo
WARNING: Problem on line 1: 0000000000000000000000000000000000000000 032a00a7391ec8a155bbc54d66ba72fb1b7bdbf1 Julien Palard <julien@palard.fr> 1521582790 +0100 branch: Created from freezed/library/colorsys.po

`.po` files can typically reside in .git/refs/heads/ if some branches
name end with .po, in which case they contain a SHA1, not
translations, leading to warnings.
 2018-05-08 11:02:14 +02:00
Takeshi KOMIYA
5c56c99dfd Fix #4913: i18n: literal blocks in bullet list are not translated 2018-05-07 22:25:42 +09:00
Takeshi KOMIYA
4c3e757ad7 refactor: Reduce DeprecationWarnings 2018-05-07 21:37:54 +09:00
Takeshi KOMIYA
fad03ea050 Rename viewcode_import to viewcode_follow_imported_members (refs: #4035) 2018-05-07 21:22:13 +09:00
Takeshi KOMIYA
f2af9ff97c
Merge branch 'master' into fix_4035_2 2018-05-06 23:27:51 +09:00
Takeshi KOMIYA
f6259c696b Adjust MAX_CITATION_LABEL_LENGTH 2018-05-03 23:46:25 +09:00
Takeshi KOMIYA
8bc136a9cb Use \sphinxcite instead of \cite 2018-05-03 20:58:30 +09:00
Takeshi KOMIYA
c1b87ff0d3 Suppress braces surround bibitem 2018-05-03 20:57:29 +09:00
Takeshi KOMIYA
92d8935df0 latex: Use `\cite for citation references instead \hyperref` 2018-05-03 20:57:29 +09:00
Takeshi KOMIYA
82a123f1d4 Add testcase for thebibliography 2018-05-03 20:50:24 +09:00
Takeshi KOMIYA
8febb09373
Merge branch 'master' into refactor_latex_footnotes 2018-05-03 11:40:44 +09:00
Takeshi KOMIYA
cbf4ee24f9 Fix #4811: The files under html_static_path are excluded from source 2018-05-03 11:07:14 +09:00
Takeshi KOMIYA
0ea06e40ca
Merge branch 'master' into 789_escape_braces_on_samp_role 2018-05-03 01:32:35 +09:00
Takeshi KOMIYA
d8f4e47fc8 Fix broken testcase caused by path separator 2018-05-02 02:13:00 +09:00
Takeshi KOMIYA
9d4b3ca0eb
Merge pull request #4879 from tk0miya/refactor_OptionParser 
Let docutils know the location of ``docutils.conf`` for Sphinx
 2018-05-01 00:32:19 +09:00
Takeshi KOMIYA
eba8792355
Merge pull request #4866 from goerz/ext_graphviz_css 
Wrap graphviz diagrams in <div class="graphviz">
 2018-04-29 22:22:29 +09:00
Takeshi KOMIYA
a31e7beee7 Merge branch 'master' into refactor_latex_footnotes 2018-04-29 21:09:46 +09:00
Takeshi KOMIYA
a68f772d7a Merge branch 'master' into refactor_config 2018-04-28 13:05:47 +09:00
Takeshi KOMIYA
b165ade6b0 Rename Config.read_from_py() to Config.read() 2018-04-28 13:05:28 +09:00
Takeshi KOMIYA
622119a9d4 Fix #789: `:samp:` role supports to escape curly braces with backslash 2018-04-28 12:56:01 +09:00
Ashley Whetter
44da51a564 Plugins can find source code for viewcode 
Fixes #4035
 2018-04-24 14:45:16 -07:00
Jean-François B
cb4da73412
Merge pull request #4868 from tesch1/feat-4830 
proposed enhancement #4830
 2018-04-24 14:00:16 +02:00
Takeshi KOMIYA
5897d45cc6 Merge branch 'master' into refactor_config 2018-04-22 18:56:04 +09:00
Takeshi KOMIYA
bafeb3eb18 Merge branch '1.7' 2018-04-22 18:19:29 +09:00
Takeshi KOMIYA
81946e423a Let docutils know the location of `docutils.conf` for Sphinx 2018-04-22 17:16:12 +09:00
Takeshi KOMIYA
61bf7c44df Fix #4717: latex: Compilation for German docs failed with LuaLaTeX and XeLaTeX 2018-04-21 18:47:11 +09:00
Michael Goerz
4a2b227376 Allow imgcls as class for SVG Graphviz <object> 
For consistency, the `<object>` tag for the SVG output of a
inheritance-diagram should have the same `class="inheritance"` attribute
that the corresponding `<img>` tag for the PNG format has. This allows
to define the CSS attribute

    object.inheritance {
        max-width: 100%;
    }

which for SVG (unlike PNG) actually works and makes sense.

Added a test for inheritance-diagrams in SVG.
 2018-04-21 00:59:27 -04:00
Michael Goerz
b689fb1c12 Wrap graphviz diagrams in <div class="graphviz"> 
The graphviz extension is modified to wrap the `<img>` and `<object>`
tags it creates for diagrams in the png and svg formats in an additional
`<div class="graphviz">...</div>` tag. This allows to apply additional
CSS styling to the the diagrams that cannot be applied to `<img>` and
`<object>` directly. Most notably,

    div.graphviz {
      overflow: auto;
    }

would be a useful style that the standard themes might consider.

In any case, it would allow users to add custom CSS code to their
project that gets around the problems with inheritance-diagrams
discussed in https://github.com/sphinx-doc/sphinx/issues/4865

The tests for the `grahviz` and `inheritance_diagram` have been modified
to test for the presence of the additional `<div>` tag.

Closes #4865
 2018-04-20 12:43:12 -04:00
Takeshi KOMIYA
86df550c66 Fix short underline 2018-04-20 23:16:41 +09:00
Takeshi KOMIYA
6977270b66 Fix #4850: latex: footnote inside footnote was not rendered 2018-04-20 21:39:42 +09:00
Michael Tesch
e368ac21ef proposed enhancement #4830 2018-04-20 13:13:00 +02:00
Jon Dufresne
365c93f227 Update all pypi.python.org URLs to pypi.org 
For details on the new PyPI, see the blog post:

https://pythoninsider.blogspot.ca/2018/04/new-pypi-launched-legacy-pypi-shutting.html
 2018-04-18 19:51:48 -07:00
Takeshi KOMIYA
96c5605374 Merge branch '1.7' 2018-04-18 11:35:10 +09:00
Takeshi KOMIYA
ef10ca11fc Fix toctree directive tries to glob for URL having query_string 2018-04-16 16:01:59 +09:00
Takeshi KOMIYA
9826d49cbd Add testcase for toctree directive 2018-04-15 13:38:58 +09:00
Takeshi KOMIYA
b1a0e8062f Fix #4767: html: search highlighting breaks mathjax equations 2018-04-15 00:30:53 +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
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
557514330f Merge branch '1.7' 2018-04-14 15:46:31 +09:00
Takeshi KOMIYA
af4647c492 Merge branch '1.7' 2018-04-14 15:43:38 +09:00
Takeshi KOMIYA
5ef8da518f Fix #4784: latex_show_urls assigns incorrect footnote numbers 2018-04-12 23:40:15 +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
245e7d7bab Fix #4812: autodoc ignores type annotated variables 2018-04-08 23:51:01 +09:00
Takeshi KOMIYA
aefb3bbaaa Fix #4543: testcase for partialmethod is failed with py3.6.5 2018-04-08 21:54:00 +09: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
47918f365e Merge branch 'master' into refactor_config 2018-04-02 10:47:47 +09:00
Takeshi KOMIYA
bc63dc8450 Rename Config.read() to Config.from_conf_py() 2018-04-01 20:07:45 +09:00
jfbu
bfdf0d1e83 Merge branch '1.7' 2018-03-30 22:50:55 +02:00
jfbu
38dc048bce Fix broken LateX customization via templates (closes: #4795) 2018-03-29 14:58:32 +02:00
jfbu
c59a0ccae1 Fix autosummary latex table colspec (closes #4790) 2018-03-28 10:03:18 +02:00
Takeshi KOMIYA
181fb1093d Now Config.read() takes a filename instead (dirname, filename) 2018-03-28 00:58:40 +09:00
Takeshi KOMIYA
9e0089b252 Fix #4769: autodoc loses the first staticmethod parameter 2018-03-24 00:53:07 +09:00
Takeshi KOMIYA
42263a07a6
Merge branch 'master' into add_override_option 2018-03-24 00:44:11 +09:00
Takeshi KOMIYA
78cbf96158 Deprecate Config.check_types() 2018-03-24 00:29:11 +09:00
Takeshi KOMIYA
3d8cb12497 Raise ExtensionError from Config class instead application class 2018-03-24 00:27:03 +09:00
Takeshi KOMIYA
e4ecb97d5a refactor testcase for config 2018-03-23 23:41:09 +09:00
Takeshi KOMIYA
ba83214386 Refactor: Add Config.read() as a constructor 
To simplify Config.__init__() method, this separates conf.py parsing
feature to Config.read() method.
This allows to instantiate config object simply.
 2018-03-23 23:40:28 +09:00
Takeshi KOMIYA
f9753e30de Merge branch '1.7' 2018-03-21 20:55:30 +09:00
Christer Bystrom
a7aac6956d Closes #4520 - acidic: Subpackage not in toc. The rule of skipping folders with only an empty __init__.py has been removed. The reason for this is that it was never working consistently in the first place and made the code unnecessary hard to reason about. Tests for the TOC generation have been added, as well as tests for the exclude mechanism since they are coupled. One test (test_ext_apidoc.py::test_exclude) has also been modified to reflect the new behaviour. 2018-03-21 14:35:58 +09:00
Takeshi KOMIYA
1a43d47c33 Add a new keyword argument `override` to Application APIs 2018-03-21 00:23:44 +09:00
Takeshi KOMIYA
cd08872cc0 Fix existence check for JRE was broken 2018-03-20 23:35:42 +09:00
Takeshi KOMIYA
cf3de7d62b
Merge pull request #4758 from tk0miya/epub_escape_toc.ncx 
epub: Fix docTitle elements of toc.ncx is not escaped
 2018-03-20 23:08:10 +09:00
Takeshi KOMIYA
9891924485 epub: Fix docTitle elements of toc.ncx is not escaped 2018-03-20 20:28:02 +09:00
Takeshi KOMIYA
049df5d5e1 test: Suppress DeprecationWarning 2018-03-20 20:27:05 +09:00
Takeshi KOMIYA
2c7d08ee47 Merge branch '1.7' 2018-03-19 23:46:15 +09:00
Takeshi KOMIYA
c271cc4542 Use template for generating .qhp file 2018-03-18 12:33:03 +09:00
Takeshi KOMIYA
dc3faa57b4 Add testcase for qthelp (.qhp files) 2018-03-18 12:33:00 +09:00
Takeshi KOMIYA
dfd550eca6 builder: Use template for generating .qhcp file 2018-03-18 12:32:56 +09:00
Takeshi KOMIYA
f3b50ebef0 Add testcase for qthelp 2018-03-18 12:32:53 +09:00
Takeshi KOMIYA
39835bf885 Fix #4720: message when an image is mismatched for builder is not clear 2018-03-18 01:35:42 +09:00
Takeshi KOMIYA
9efaf18852 Merge branch '1.7' 2018-03-18 01:21:01 +09:00
Jean-François B
e1e46cdf8b
Merge pull request #4729 from jfbu/latex_equation_nophantom 
Fix vertical space before equation in latex (closes: #4574)
 2018-03-15 10:29:10 +01:00
Takeshi KOMIYA
4cebc4399c Merge commit '6694981dd6939ab876b27d4e20a8128561c307ac' 2018-03-15 02:02:21 +09:00
Takeshi KOMIYA
f2a23b761e Fix #4543: test for autodoc fails with python 3.5.3 2018-03-13 23:23:15 +09:00
jfbu
711b8ecf70 Fix vertical space before equation in latex (closes: #4574) 2018-03-11 11:36:16 +01:00
Takeshi KOMIYA
e4fd16af9f
Merge pull request #4719 from tk0miya/relax-numref-on-sections 
Relax numref on sections
 2018-03-08 20:39:08 +09:00
Takeshi KOMIYA
88abc67bf8 Merge branch '1.7' into relax-numref-on-sections 2018-03-08 01:11:12 +09:00
Takeshi KOMIYA
31db987d68 Update testcases 2018-03-08 01:11:07 +09:00
Takeshi KOMIYA
5c07c053e4
Merge pull request #4715 from tk0miya/4611_fix_epubfilename 
Fix filename of epub (refs: #4611)
 2018-03-08 00:59:58 +09:00
Takeshi KOMIYA
11fa47769b Fix filename of epub (refs: #4611) 2018-03-07 10:53:01 +09:00
Takeshi KOMIYA
9bd3aaf3dc
Merge branch '1.7' into 4701_viewcode 2018-03-07 10:34:46 +09:00
Takeshi KOMIYA
f1c6c22e84 Fix #4701: viewcode: Misplaced `<div>` in viewcode html output 2018-03-05 23:46:34 +09:00
Takeshi KOMIYA
fdefe987d5 Fix #4689: autosummary: unexpectedly strips docstrings containing "i.e." 2018-03-04 02:12:13 +09:00
Takeshi KOMIYA
e2f481c956 Merge branch '1.7' 2018-03-03 20:03:45 +09:00
Takeshi KOMIYA
278577c2ef
Merge branch 'master' into improve_i18n 2018-03-01 23:38:38 +09:00
Takeshi KOMIYA
c435bcf8dc Fix #4685: autosummary emits meaningless warnings 2018-03-01 22:29:50 +09:00
Takeshi KOMIYA
bc31485b10 Fix i18n: message catalogs were reset on each initialization 2018-02-25 23:44:38 +09:00
Takeshi KOMIYA
cf62badce9 Add namespace feature to sphinx.locale 2018-02-25 23:44:37 +09:00
Takeshi KOMIYA
f5bc9fd5dd Add testcases 2018-02-25 23:44:37 +09:00
Takeshi KOMIYA
d01d494119 Deprecate env.update()! 
To make BuildEnvironment simple, the responsibility of converting
source files to doctrees is moved to Builder class.
 2018-02-24 13:06:46 +09:00
Takeshi KOMIYA
a2bce15989 Merge branch '1.7' 2018-02-23 23:44:00 +09:00
Takeshi KOMIYA
cd08a6503c Fix #4664: Reading objects.inv fails again 2018-02-23 10:44:11 +09:00
Takeshi KOMIYA
30cab5c376
Merge branch 'master' into migrate_registry 2018-02-22 20:21:09 +09:00
Takeshi KOMIYA
f6b1abf254
Merge pull request #4594 from tk0miya/4564_rst_prolog_not_working 
Change interface of add_source_parser() and add add_source_suffix()
 2018-02-22 20:19:13 +09:00
Takeshi KOMIYA
5789b25847 Change interface of add_source_parser() and add add_source_suffix() 2018-02-21 10:54:49 +09:00
Takeshi KOMIYA
9c6d4f1308 Add simple wrapper to register nodes 2018-02-21 00:28:03 +09:00
Jakob Lykke Andersen
bde93246c6 C++, parse 'this' in expressions. 2018-02-19 20:58:55 +01:00
Jakob Lykke Andersen
7d49a5311f C++, parse explicit casts and typeid in expression 2018-02-19 20:58:10 +01:00
Takeshi KOMIYA
56fe1d0414
Merge pull request #4644 from tk0miya/4641_toctree_glob_and_url 
Fix #4641: A external link in TOC cannot contain "?" with ``:glob:`` option
 2018-02-20 01:50:54 +09:00
Takeshi KOMIYA
18efa1a63a refactor: Store enumerable_nodes to registry 2018-02-20 01:32:30 +09:00
Takeshi KOMIYA
4073d4e850 Fix flake8 violations 2018-02-20 00:08:44 +09:00
Takeshi KOMIYA
938ba386ed Merge branch '1.7' 2018-02-20 00:02:57 +09:00
Takeshi KOMIYA
63f6603297
Merge pull request #4651 from tk0miya/fix_flake8_violations 
Fix flake8 violations
 2018-02-19 23:57:00 +09:00
Takeshi KOMIYA
d2b2cefe69
Merge pull request #4642 from tk0miya/4611_epubcheck 
test: Run epubcheck as a testing
 2018-02-19 23:31:35 +09:00
Takeshi KOMIYA
07de0ed10b Fix #4641: A external link in TOC cannot contain "?" with `:glob:` option 2018-02-19 23:27:57 +09:00
Takeshi KOMIYA
f7027049b1 Fix flake8 violations 2018-02-19 23:20:56 +09:00
Takeshi KOMIYA
e0a74a3f40
Merge branch '1.7' into 4577_nested_enumlist 2018-02-19 22:48:54 +09:00
Takeshi KOMIYA
d40db5efa2 Fix #4563: autosummary: Incorrect end of line punctuation detection 2018-02-19 14:42:19 +09:00
Takeshi KOMIYA
20613edc03 refactor: Add extract_summary() for easily testing 2018-02-19 14:40:39 +09:00
cocoatomo
f3d13d9ce7 Fix the dirname for testing files 2018-02-19 09:51:30 +09:00
cocoatomo
07d2cdd47b Add a testcase for deterministic msgid order 2018-02-19 08:57:19 +09:00
Takeshi KOMIYA
2523979d26 test: Run epubcheck as a testing 2018-02-19 00:27:45 +09:00
Takeshi KOMIYA
6beab9c5a4 Fix #4577: Enumerated sublists with explicit start with wrong number 2018-02-18 17:29:17 +09:00
Takeshi KOMIYA
f8bb40ab30 Merge branch '1.7' 2018-02-18 12:39:07 +09:00
Roman Kapl
675b8fe48f Fit graphviz images to page. 
Use \sphinxincludegraphics, that's what the core image directives use
and it handles fitting properly.
 2018-02-17 10:07:00 +09:00
Roman Kapl
4a913e5cee Fit graphviz images to page. 
Use \sphinxincludegraphics, that's what the core image directives use
and it handles fitting properly.
 2018-02-16 18:16:32 +01:00
Takeshi KOMIYA
ec8226daa7
Merge pull request #4612 from tk0miya/optimize_latex_testcase 
Use roots/basic for test_latex_logo_if_not_found
 2018-02-17 00:25:32 +09:00
Patrick Wingo
e505cbb3be Napoleon: custom section headers (#4387) 
* Changes to allow for custom sections in google/numpy comments when parsing with napoleon

* fixed some formatting to pass flake8 tests
 2018-02-15 16:16:23 -05:00
Martin Larralde
4d7c90d857 Implement missing napoleon admonitions 2018-02-13 18:02:02 +01:00
Takeshi KOMIYA
5b02d61a04 Use roots/basic for test_latex_logo_if_not_found 2018-02-14 01:35:00 +09:00
Takeshi KOMIYA
795ca7a0c9 Fix #4260: autodoc: keyword only argument separator is not disappeared 2018-02-13 02:13:38 +09:00
Takeshi KOMIYA
6cf0698b0c Merge branch '1.7' 2018-02-12 16:20:00 +09:00
Takeshi KOMIYA
e700f0ba99 Fix #4581: apidoc: Excluded modules still included 2018-02-11 22:10:33 +09:00
Takeshi KOMIYA
e5adf8ce91 Merge branch '1.7-release' 2018-02-11 19:35:48 +09:00
Takeshi KOMIYA
ae38d556b7 Combine tests for autosectionlabel 2018-02-11 13:54:47 +09:00
Kit La Touche
481b1ad535 Remove extraneous import 2018-02-11 13:53:29 +09:00
Kit La Touche
4beb4d0066 Fix unicode issues 2018-02-11 13:53:29 +09:00
Kit La Touche
29a3fd0acb Handle older docutils 2018-02-11 13:53:29 +09:00
Kit La Touche
f21b9d5892 Use rawsource in autosectionlabel 
Fixes #4027.
 2018-02-11 13:52:27 +09:00
Takeshi KOMIYA
e84ba569a2 Merge branch '1.7-release' 2018-02-10 15:46:48 +09:00
Takeshi KOMIYA
0f1168308b
Merge branch '1.7-release' into 4560_i18n_compilation_problem 2018-02-10 11:53:14 +09:00
Zac-HD
b62628f678 Avoid misreporting line number 2018-02-09 11:05:26 +11:00
Zac-HD
68bccb01ac Get correct filename for each doctest block 
This is complicated because doctests may be included from other files,
eg. dosctrings in a Python module.
 2018-02-09 11:05:25 +11:00
Zac-HD
973f2680d6 Add ext.autodoc + ext.doctest test root 2018-02-09 10:39:25 +11:00
Takeshi KOMIYA
a9f370bc12 test: Remove function based directives 2018-02-08 13:50:25 +09:00
Takeshi KOMIYA
afbd27f996 Fix i18n: message catalogs are not compiled when specific build (refs: #4560) 
sphinx-build skips message catalog builds if specific filename are given
as arguments.
 2018-02-08 12:44:15 +09:00
Stephen Finucane
05f851fa19 trivial: Remove 'tests/etree13' 
This vendored code had no callers in modern Sphinx and has not been
needed since Python 2.5, which included the ElementTree API [1], was
released. It can be removed in its entirety.

[1] https://docs.python.org/2/library/xml.etree.elementtree.html

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-02-06 20:15:25 +00:00
cocoatomo
8969ae40de Make the log message more translation-friendly 2018-02-07 01:52:22 +09:00
Takeshi KOMIYA
51dfa73576 Fix #4543: test for autodoc fails with python 3.5.3 2018-02-05 14:38:35 +09:00
Takeshi KOMIYA
5558b63315 Merge branch '1.7-release' 2018-02-04 23:24:38 +09:00
Takeshi KOMIYA
656e3be754 Fix #4539: autodoc emits warnings for partialmethods 2018-02-04 23:23:43 +09:00
Takeshi KOMIYA
18c0b23797 Merge branch 'stable' into 1.7-release 2018-02-04 23:20:48 +09:00
Rob Ruana
eb39f5714a
Merge pull request #4047 from AWhetter/fix_2979_2 
Properties can have types documented with :type:
 2018-02-03 17:42:49 -05:00
Takeshi KOMIYA
498fa379ef
Merge pull request #4540 from tk0miya/4539_warnings_for_partialmethods 
Fix #4539: autodoc emits warnings for partialmethods
 2018-02-03 17:39:58 +09:00
Takeshi KOMIYA
758e051ed2 Fix #4539: autodoc emits warnings for partialmethods 2018-02-03 17:25:48 +09:00
Takeshi KOMIYA
929379d0ce Fix #2372: autosummary: invalid signatures are shown for type annotated functions 2018-02-03 16:53:26 +09:00
Takeshi KOMIYA
23796c35bf Merge branch '1.7-release' 2018-02-03 02:16:40 +09:00
Takeshi KOMIYA
39d4584248 Merge branch 'stable' into 1.7-release 2018-02-03 02:14:06 +09:00
Daniel Pizetta
d3d4d94970 Add test for fix #4019 2018-02-01 17:29:18 -02:00
Takeshi KOMIYA
4647fcee45 Merge branch '1.7-release' 2018-01-31 20:40:56 +09:00
Takeshi KOMIYA
43ee8d194d intersphinx: Add testcase for inventory fallbacks 2018-01-31 01:22:33 +09:00
Takeshi KOMIYA
a5fea73d0c Merge branch 'master' into integrate_source_suffix_and_source_parsers 2018-01-31 00:04:11 +09:00
Takeshi KOMIYA
2994014cf9
Merge pull request #4247 from jorisvandenbossche/autosummary-attributes 
BUG: autosummary to list all class members
 2018-01-30 10:44:18 +09:00
Takeshi KOMIYA
00a961a573
Merge pull request #4519 from tk0miya/4209_intersphinx_and_not_versioned_docs 
Fix #4209: intersphinx: In link title, "v" should be optional if target has no version
 2018-01-30 00:57:44 +09:00
Takeshi KOMIYA
cb5cf26c85 Merge branch 'stable' into 1.7-release 2018-01-30 00:20:45 +09:00
Takeshi KOMIYA
aa47e9decc Fix #4209: intersphinx: In link title, "v" should be optional if target has no version 2018-01-30 00:14:53 +09:00
Takeshi KOMIYA
8494638e45 Fix graphviz: workaround for wrong map ID which graphviz generates 2018-01-29 22:33:23 +09:00
Takeshi KOMIYA
2312a0a5bc Fix #4501: graphviz: epub3 validation error caused if graph is not clickable 2018-01-29 22:32:58 +09:00
Takeshi KOMIYA
3cdb3da2df
Merge branch '1.7-release' into 4275_update_strftime 2018-01-28 20:13:35 +09:00
Takeshi KOMIYA
321b3d49cb Fix #3952: apidoc: module header is too escaped 2018-01-28 18:58:58 +09:00
Takeshi KOMIYA
f3812b0d18 Fix #4275: Formats accepted by sphinx.util.i18n.format_date are limite 2018-01-28 17:22:41 +09:00
Takeshi KOMIYA
10ad257780
Merge branch '1.7-release' into 4490_format_annotation_for_py37 2018-01-28 02:09:57 +09:00
Takeshi KOMIYA
af25fa123d Merge branch 'stable' into 1.7-release 2018-01-28 00:18:33 +09:00
Takeshi KOMIYA
fd2425238e Fix #4490: autodoc: type annotation is broken with python 3.7.0a4+ 2018-01-27 12:26:53 +09:00
Takeshi KOMIYA
0cdd9ee72a Integrate source_suffix and source_parsers (refs: #4474) 2018-01-25 02:03:56 +09:00
Takeshi KOMIYA
bece0484e5 source_parsers should fill Parser.supported attribute to let Sphinx know supported formats 2018-01-25 02:03:56 +09:00
Takeshi KOMIYA
068bbb1b8a
Merge pull request #4449 from dhellmann/stable-fix-autodoc-for-empty-packages 
fix ext.apidoc to include "empty" packages that contain modules
 2018-01-25 01:15:36 +09:00
Takeshi KOMIYA
9340a45393 test: Don't use os.errno. Use errno directly 2018-01-25 00:48:37 +09:00
Takeshi KOMIYA
f779fa7ad6 Merge branch 'stable' into 1.7-release 2018-01-25 00:40:21 +09:00
Takeshi KOMIYA
ded638c82b test: Add workaround for python 3.7.0a4+ 
Since 3.7.0a+, the behavior of typing module has been changed.
As a result, format_annotation() also has been changed.
 2018-01-25 00:02:49 +09:00
Doug Hellmann
83f30712b8 fix ext.apidoc to include "empty" packages that contain modules 
Commit 2d99648e99 changed the apidoc
extension to ignore packages if the __init__.py file was empty. That
breaks the toctree structure if those packages do contain submodules
and subpackages. This patch adds a check to ensure that empty
__init__.py modules are only skipped if there are no other python
modules in the same directory.

Addresses bug #654

Signed-off-by: Doug Hellmann <doug@doughellmann.com>
 2018-01-23 14:21:03 -05:00
Takeshi KOMIYA
91873f09b8 Merge branch 'stable' into 1.7-release 2018-01-21 16:06:14 +09:00
Aaron Carlisle
e77ca75103 Update test file 2018-01-21 13:18:29 +09:00
Takeshi KOMIYA
896ab3a2f5 Fix #4434: pure numbers as link targets produce warning 2018-01-20 19:43:43 +09:00
jfbu
d2d31e2e7d Fix failed latex test after merge 2018-01-20 10:48:27 +01:00
jfbu
02ee4ec86b Merge branch 'stable' into 1.7-release 2018-01-20 10:38:03 +01:00
Jean-François B
d3058f462d
Merge pull request #4452 from jfbu/4431_fix 
Fix "Undefined control sequence \\hlineSomeText" (#4431; refs: #3435)
 2018-01-20 10:23:03 +01:00
Takeshi KOMIYA
a78f66a1d3
Merge branch 'stable' into fix-2437 2018-01-20 16:16:20 +09:00
Takeshi KOMIYA
d1d55eb35f Fix broken test 2018-01-20 10:54:53 +09:00
Takeshi KOMIYA
8b8c3d1736 Merge branch 'stable' into 1.7-release 2018-01-20 02:22:35 +09:00
Takeshi KOMIYA
295323d5aa Fix #4415: autodoc classifies inherited staticmethods as regular methods 2018-01-20 01:10:47 +09:00
Takeshi KOMIYA
cbb10d61f7 Fix #4415: autodoc classifies inherited classmethods as regular methods 2018-01-20 01:10:47 +09:00
Takeshi KOMIYA
f91c732749 Fix #4438: math: math with labels with whitespace cause html error 2018-01-19 23:13:21 +09:00
Takeshi KOMIYA
357fba4467 Fix #4412: Updated jQuery version from 3.1.0 to 3.2.1 2018-01-19 14:45:11 +09:00
jfbu
9aca29a781 Fix "Undefined control sequence \\hlineSomeText" (#4431; refs: #3435) 2018-01-18 15:35:59 +01:00
Takeshi KOMIYA
dc3d03da1b test: Fix broken testcases 2018-01-15 01:01:13 +09:00
Takeshi KOMIYA
b688941b09
Merge branch 'master' into feature-text-secnumbers 2018-01-15 00:21:50 +09:00
Robin Jarry
c24dffc5a8 autodoc: only mock specified modules with their descendants 
Do not mock the ancestors of the specified modules in
autodoc_mock_imports. Only mock the modules themselves and their
descendants (as specified in the docs).

Fix the test configs accordingly.

Signed-off-by: Robin Jarry <robin@jarry.cc>
 2018-01-13 17:24:02 +01:00
Takeshi KOMIYA
4d040abafb Fix #4079: Add notranslate class to let Google Translate know they are not translatable 2018-01-13 20:25:49 +09:00
Takeshi KOMIYA
c50b21af0e
Merge branch 'master' into 3570_drop_typing_from_typehints 2018-01-13 14:43:31 +09:00
Takeshi KOMIYA
7e365d97ac
Merge pull request #4235 from anarcat/manpage-links 
add link to manpages in HTML builder
 2018-01-13 14:28:11 +09:00
Takeshi KOMIYA
f5b1aff2d1
Merge branch 'master' into 4183_follow_pep440 2018-01-13 13:12:32 +09:00
Takeshi KOMIYA
7292386a03 Fix #3570: autodoc: Do not display typing. module for type hints 2018-01-13 12:08:31 +09:00
Takeshi KOMIYA
76c5395c5b Merge remote-tracking branch 'atodorov/inheritance_top_class' 2018-01-13 11:08:31 +09:00
Sergey B Kirpichev
b1c100ca3b autodoc: make full reference for classes, aliased with "alias of" 
We do this here only if class belongs to the different module.

Closes sphinx-doc/sphinx#2437
 2018-01-13 00:19:19 +03:00
Antoine Beaupré
90f7c7ef3f
add link to manpages in HTML builder 
It is useful to have the HTML documentation builder actually link to
real rendered versions of HTML manpages in its output. That way people
can click on manpages to get the full documentation. There are a few
services offering this online, so we do not explicitly enable one by
default, but the Debian manpages repository has a lot of the manpages
pre-rendered, so it is used as an example in the documentation.

The parsing work is done by a transformer class that parses manpage
objects and extract name/section elements. Those then can be used by
writers to cross-reference to actual sites. An implementation is done
in the two HTML writers, but could also apply to ePUB/PDF writers as
well in the future.

This is not enabled by default: the `manpages_url` configuration item
needs to be enabled to point to the chosen site. The `page`, `section`
and `path` parameters are expanded through Python string formatting in
the URL on output.

Unit tests are fairly limited, but should cover most common use-cases.
 2018-01-11 13:20:34 -05:00
Takeshi KOMIYA
33fd1f446a latex: Do not display Release label if :confval:release is not set 2018-01-10 21:35:21 +09:00
Takeshi KOMIYA
161f269202
Merge pull request #4406 from sphinx-doc/stable 
stable to master
 2018-01-10 01:01:09 +09:00
Takeshi KOMIYA
e77267dd94 Add tests for smartquotes 2018-01-09 23:37:37 +09:00
Takeshi KOMIYA
326d7e64ce Merge branch 'master' into dont_emit_system_message_on_autodoc_warning 2018-01-08 20:19:36 +09:00
Takeshi KOMIYA
fb921c7457 Merge branch 'master' into refactor_autodoc 2018-01-08 15:10:43 +09:00
Takeshi KOMIYA
42000e0f00
Merge pull request #4382 from tk0miya/refactor_PYTHONWARNINGS 
refactor warnings settings on testing
 2018-01-08 14:24:37 +09:00
Takeshi KOMIYA
273f834157 Fix #4081: Warnings and errors colored the same when building 2018-01-08 12:29:06 +09:00
Takeshi KOMIYA
7ba54500fc Fix #4183: doctest: `:pyversion:` option also follows PEP-440 specification 2018-01-08 11:59:50 +09:00
Joel Nothman
db415ba05c Avoid duplicate calls to autodoc-process-docstring (#4198) 2018-01-08 11:09:29 +09:00
Takeshi KOMIYA
2ae7f26fe5 test: Adjust testcase for #3962 2018-01-07 12:09:41 +09:00
Takeshi KOMIYA
e18c49ec59 Merge commit '4277eb13315d5649401190df86874b3832ddfa3e' 2018-01-07 01:13:32 +09:00
Takeshi KOMIYA
e1d8615ce4 Don't use add_documenter() in sphinx-autogen 2018-01-07 00:05:48 +09:00
Takeshi KOMIYA
23533e48b2 Update PYTHONWARNINGS on tox.ini to reduce meaningless warnings 2018-01-06 20:14:20 +09:00
jfbu
309f38a91f Split out fancy LaTeX macros from `\sphinxcode into \sphinxupquote` 
Since #2627 (1.4.4), `\code`, and then again at #3116 (1.5)
`\sphinxcode` which is the new name has become more complicated than the
original `\texttt{#1}`. This was to obtain straight quotes in PDF output,
and to allow long inline literals to break across lines.

This means though that users who want to customize `\sphinxcode`, for
example to not only do `\texttt` but to use some colour, have to copy
about 10 lines of complicated LaTeX macros which should be not modified
in any way. This commit moves all the code out of `\sphinxcode` into a
separate macro `\sphinxupquote`.

The LaTeX writer will output `\sphinxcode{\sphinxupquote{foo}}` in place
of former `\sphinxcode{foo}`. Moving the `\texttt` from innermost to
outermost level is with no consequence.
 2018-01-03 08:46:19 +01:00
Takeshi KOMIYA
850e9a9c5c Fix links to external option docs with intersphinx (refs: #3769) 2018-01-02 01:01:29 +09:00
Takeshi KOMIYA
5d6413b712 Deprecate sphinx.ext.autodoc.add_documenter() and AutoDirective._register 2018-01-01 12:13:29 +09:00
Takeshi KOMIYA
023dad6c66
Merge pull request #4335 from zufallsgenerator/fix-4334-apidoc-toc-inconsistencies 
Closes #4334: sphinx-apidoc: References to non-existing files in TOC
 2018-01-01 12:03:32 +09:00
Takeshi KOMIYA
5562e76585 A happy new year! 2018-01-01 01:10:10 +09:00
Takeshi KOMIYA
f1f6ca8cc9 Merge branch 'happy_new_year' into master 2018-01-01 01:09:17 +09:00
Takeshi KOMIYA
2426cedb8b A happy new year! 2018-01-01 01:06:58 +09:00
Takeshi KOMIYA
e8402bf0ee Merge branch 'stable' 2017-12-31 21:13:34 +09:00
Takeshi KOMIYA
1cae50f748
Merge branch 'stable' into 4a164170-33e9-4df3-aad2-a13af37b6b43 2017-12-31 20:43:16 +09:00
Takeshi KOMIYA
40186077d7
Merge pull request #4358 from tk0miya/ensure_parallelism 
Ensure parallelism
 2017-12-30 10:04:22 +09:00
Takeshi KOMIYA
1d3362425b Add app.is_parallel_allowed() 2017-12-30 00:54:55 +09:00
Stephen Finucane
9a3ebaaff5 Resolve warning filter issues 
There's an issue with 'pkgutils' and namespace packages. This has been
reported against setuptools [1], but until this is resolved, we simply
need to live with it. Ensure said warnings are filtered from tox too and
remove some unnecessary ones.

[1] https://github.com/pypa/setuptools/issues/1111

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2017-12-29 13:02:32 +00:00
Stephen Finucane
7c0723fd46 tests: Remove 'tests/run.py' 
This is no longer necessary. One test needs to be modified to deal with
how 'python -m pytest' modifies the PATH.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2017-12-29 13:02:31 +00:00
Stephen Finucane
529c96a3c9 tests: Use 'pytest_sessionstart' 
This is the recommended way to do pre-session configuration in pytest if
not using session fixtures [1].

With this, we're able to remove the custom 'test/run.py' script in its
entirety and run 'pytest' like everyone else does. We'll do this
separately to keep things simple.

[1] https://stackoverflow.com/a/12600154/613428

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2017-12-29 13:02:26 +00:00
Stephen Finucane
c33ecd1f8f tests: Use 'pytest_report_header' 
This is the recommended way to print extra headers [1].

[1] https://docs.pytest.org/en/latest/example/simple.html#adding-info-to-test-report-header

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2017-12-29 13:02:07 +00:00