Commit Graph

15881 Commits

Author SHA1 Message Date
Takeshi KOMIYA
a555e3db8a Fix #8200: autodoc: type aliases break type formatting
The annotation option is shared between auto directives unexpectedly.
It causes supression of type annotations for objects after
GenericAlias definition.
2020-10-03 22:35:35 +09:00
Takeshi KOMIYA
88b81a06eb
Merge pull request #8272 from francoisfreitag/strip_whitespaces
Strip trailing whitespaces and normalize line endings
2020-10-03 21:42:53 +09:00
Takeshi KOMIYA
1eaa06844e
Merge pull request #8269 from francoisfreitag/raise-anchor
Fix #8268: make linkcheck report HTTP errors
2020-10-03 21:42:29 +09:00
François Freitag
5ea8ee133d
Fix #8268: make linkcheck report HTTP errors 2020-10-03 14:33:29 +02:00
François Freitag
5166dd194c
Strip trailing whitespaces and normalize line endings
Trailing whitespace do not have impact on the result, they are just
unused bytes. Most text editors are configured to strip trailing
whitespaces. Remove them all in one go.

Update a handful of files to use the UNIX line ending.
2020-10-03 13:47:01 +02:00
Takeshi KOMIYA
1e2ccd8f0e
Merge pull request #8007 from tk0miya/6518_autodoc_typehints_evaluation
Close #6518: autodoc: Add autodoc_type_aliases
2020-10-03 16:13:18 +09:00
Takeshi KOMIYA
f2c0dfe7c4 Close #6518: autodoc: Add autodoc_type_aliases
autodoc_type_aliases allows to keep user defined type alises not
evaluated in the generated document.
2020-10-03 16:03:35 +09:00
Takeshi KOMIYA
9175da437e
Merge pull request #8226 from tk0miya/fix_typo_in_latex_builder
latex: Fix a typo (refs: #8206)
2020-10-03 01:27:24 +09:00
Takeshi KOMIYA
1ff1f3cf5b Update CHANGES for PR #8142 2020-10-03 01:25:50 +09:00
Takeshi KOMIYA
ec06f5571e
Merge pull request #8142 from jcarrano/typing-generic-signatures
autodoc: fix constructor signatures for classes derived from typing.Generic
2020-10-03 01:23:36 +09:00
Takeshi KOMIYA
bbf0754db1 Update CHANGES for PR #8257 2020-10-02 01:17:43 +09:00
Takeshi KOMIYA
483bf2c192
Merge pull request #8257 from rscohn2/test-parallel
add parallel to SphinxTestApp
2020-10-02 01:16:57 +09:00
Robert Cohn
3d81abef9c respond to review comments 2020-10-01 11:12:39 -04:00
Robert Cohn
c08214fe92 add parallel to SphinxTestApp 2020-09-30 20:47:56 -04:00
Takeshi KOMIYA
d8c006f1c0
Merge pull request #8225 from tk0miya/8175_intersphinx_redos
Fix #8175: intersphinx: Potential of regex denial of service by inventory
2020-09-29 01:58:07 +09:00
Takeshi KOMIYA
3f584155a5 Update CHANGES for PR #8239 2020-09-28 01:41:49 +09:00
Takeshi KOMIYA
574b3da4fb
Merge pull request #8239 from silene/fix_productionlist_references
Fix references to production names.
2020-09-28 01:39:16 +09:00
Takeshi KOMIYA
f7b872e673 Fix #8175: intersphinx: Potential of regex denial of service by inventory 2020-09-28 01:35:09 +09:00
Takeshi KOMIYA
a81c45367a
Merge pull request #8224 from tk0miya/8172_napoleon_redos
Fix #8172: napoleon: Potential of regex denial of service in google style docs
2020-09-28 01:27:57 +09:00
Takeshi KOMIYA
f6ae4dd4ed
Merge branch '3.x' into 8172_napoleon_redos 2020-09-28 01:15:40 +09:00
Takeshi KOMIYA
054dc5d5df
Merge pull request #8240 from nathanshammah/mitiq
Add mitiq to list of libraries using Sphinx
2020-09-27 15:59:34 +09:00
Nathan Shammah
189406f65b add mitiq to examples 2020-09-23 19:53:47 +02:00
Guillaume Melquiond
d0ba4f8d44 Strip the token name from productionlist.
When the user tries to align production rules, Sphinx gets confused by
spaces around leading tokens. In the following, references to mygroup:bad1
and mygroup:bad2 are missing, while the one to mygroup:correct is present.

    .. productionlist:: mygroup
       correct: `correct` | `bad1` | `bad2`
       bad1   : `correct` | `bad1` | `bad2`
          bad2: `correct` | `bad1` | `bad2`

Since it is useful to be able to align colons in a production list, this
commit systematically strips leading and trailing whitespaces from the
production name.
2020-09-23 18:48:57 +02:00
Takeshi KOMIYA
9dd416460c
Merge pull request #8227 from bdice/patch-1
Fix typo in autodoc docs.
2020-09-21 09:52:25 +09:00
Bradley Dice
a0116eaa58
Fix typo: anchestor -> ancestor. 2020-09-20 17:36:01 -05:00
Takeshi KOMIYA
17ef17b1ef
Merge pull request #8086 from tk0miya/8081_support_adding_latex_package_in_latter_phase
Close #8081: latex: Allow to add LaTeX package until writing tex file
2020-09-21 01:40:07 +09:00
Takeshi KOMIYA
28a7040f7b
Merge pull request #8202 from tk0miya/8190_autodoc-process-docstring-without_ending_blankline
Fix #8190: autodoc: parse error for docstring w/o ending blank lines
2020-09-21 01:02:04 +09:00
Takeshi KOMIYA
5ef4825b57 Close #8081: latex: Allow to add LaTeX package until writing tex file
This postpones the evaluation of LaTeX packages via
``app.add_latex_package()`` to just before writing .tex file.  That
allows extensions to add LaTeX packages during reading and resolving
phase.
2020-09-21 01:01:49 +09:00
Takeshi KOMIYA
b454d4e4b0
Merge branch '3.x' into 8190_autodoc-process-docstring-without_ending_blankline 2020-09-21 00:49:23 +09:00
Takeshi KOMIYA
51a276920e latex: Fix a typo (refs: #8206)
Fix a typo in the name of function: install_pakcages_for_ja()
2020-09-21 00:45:20 +09:00
Takeshi KOMIYA
3c017dcdee
Merge pull request #8206 from tk0miya/6169_pxjahyper_is_loaded_for_non_platex
Fix #8169: LaTeX: pxjahyper loaded even when latex_engine is not platex
2020-09-21 00:43:38 +09:00
Takeshi KOMIYA
d24d380421
Merge pull request #8147 from return007/only-builtin-classes-inheritance-diagram
Fixes #8146: When identifying bases, only use classes from builtins
2020-09-20 18:02:10 +09:00
Takeshi KOMIYA
f00e75278c Fix #8172: napoleon: Potential of regex denial of service in google style docs 2020-09-20 17:34:49 +09:00
Jakob Lykke Andersen
008d0201e1
Merge pull request #8207 from jakobandersen/c_alias_recursive
C, recursive alias declarations
2020-09-15 19:51:16 +02:00
Takeshi KOMIYA
000210e7c2
Merge pull request #8111 from tk0miya/8103_cached_property
Fix #8103: autodoc: cached_property is not considered as a property
2020-09-16 00:58:11 +09:00
Jakob Lykke Andersen
500f45fd4c C, recursive alias declarations
Fixes sphinx-doc/sphinx#8141
2020-09-13 16:37:53 +02:00
Takeshi KOMIYA
564a577a4a Fix #8169: LaTeX: pxjahyper loaded even when latex_engine is not platex 2020-09-13 11:10:33 +09:00
Takeshi KOMIYA
dfbe687db6
Merge branch '3.x' into 8103_cached_property 2020-09-13 11:07:33 +09:00
Takeshi KOMIYA
1d0b424898
Merge pull request #8112 from tk0miya/8100_better_error_for_html_static_files
Close #8100: html: Show a better error message for html_static_files
2020-09-13 11:06:41 +09:00
Takeshi KOMIYA
0b44e68d4f Merge branch '3.2.x' into 3.x 2020-09-13 10:51:15 +09:00
Takeshi KOMIYA
b5dc3adf66
Merge pull request #8205 from tk0miya/test_with_pygments270
Fix our test failed with pygments-2.7.0
2020-09-13 10:50:50 +09:00
Takeshi KOMIYA
85b24a2e88 Fix our test failed with pygments-2.7.0
Since pygments-2.7.0, it has changed the style of output HTML.
That makes our test broken.  This fixes it to pass with new pygments.
2020-09-13 10:42:07 +09:00
Takeshi KOMIYA
be714fa75b
Merge pull request #8177 from sphinx-doc/dependabot/npm_and_yarn/http-proxy-1.18.1
Bump http-proxy from 1.17.0 to 1.18.1
2020-09-13 01:42:26 +09:00
Takeshi KOMIYA
5b226b9c87
Merge pull request #8193 from tk0miya/8192_napoleon_removes_description
Fix #8192: napoleon: description is disappeared by inline literals
2020-09-13 01:41:43 +09:00
Takeshi KOMIYA
c05c1320fa
Merge pull request #8174 from tk0miya/8163_update_warning
Fix #8163: Update warning message for :dedent: option
2020-09-13 01:41:03 +09:00
Jakob Lykke Andersen
59766c2351 Update CHANGES after PR 2020-09-12 14:33:57 +02:00
Jakob Lykke Andersen
46a6b0848b
Merge pull request #8188 from utzig/fix-c-domain-intersphinx
domains: c: add missing intersphinx object types
2020-09-12 14:32:01 +02:00
Takeshi KOMIYA
fd3d654c17 Fix #8190: autodoc: parse error for docstring w/o ending blank lines
autodoc raises a parsing error if some extension generates a docstring
not having blank lines at the tail.  This appends a blank line if
generated one does not contain it.
2020-09-12 16:04:41 +09:00
Takeshi KOMIYA
42bfed2cb3 Fix #8192: napoleon: description is disappeared by inline literals
The napoloen wrongly parses a parameter definition because regexp
matches literal string by longest match unexpectedly.
2020-09-10 22:34:38 +09:00
Fabio Utzig
8c4193027b domains: c: add missing intersphinx object types
For intersphinx to be able to resolve references to C-Domain objects, it
needs to have them declared in the obj_types dict. This is currently
missing enum, enumerator, struct and union so those can't be referenced
by an external project. This commit fixes the issue by adding them.

Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
2020-09-09 09:46:46 -03:00