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
16,117 Commits 2 Branches 219 Tags 163 MiB
a4ccca76ec
Commit Graph

16117 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
2d37ba4419 autodoc: deprecate SingledispatchFunctionDocumenter 
In #7487, SingledispatchFunctionDocumenter is merged into
FunctionDocumenter.  SingledispatchMethodDocumenter is also.  As a result,
They are no longer needed.  So this deprecates them.
 2020-10-04 13:50:10 +09:00
Takeshi KOMIYA
d8cb7aa4f6
Merge pull request #8120 from tk0miya/6640_allow_to_override_system_message 
Fix #6640: i18n: Failed to override system message translation
 2020-10-04 13:48:04 +09:00
Takeshi KOMIYA
37235c71e0 Fix #6640: i18n: Failed to override system message translation 
Our document describes that users can override system messages via
their own message catalog named `sphinx.mo` under the locale_dirs.
But it has not been used since its beginning of i18n mechanism because
the priority of users' message catalog is lower than system's.

This makes the priority of users' message catalog higher than system's.
 2020-10-04 13:31:37 +09:00
Takeshi KOMIYA
795747bdb6
Merge pull request #8265 from tk0miya/7964_tuple_in_signature 
Fix #7964: autodoc: Tuple in default value is wrongly rendered
 2020-10-04 12:06:45 +09:00
Takeshi KOMIYA
3096b71c1c
Merge branch '3.x' into 7964_tuple_in_signature 2020-10-04 11:53:41 +09:00
Takeshi KOMIYA
b428cd2404
Merge pull request #8264 from tk0miya/8157_TypeError_for_invalid_args 
Fix #8157: autodoc: TypeError is raised when annotation has invalid __args__
 2020-10-04 11:52:54 +09:00
Takeshi KOMIYA
9a0a0f9ae1 Fix #8157: autodoc: TypeError is raised when annotation has invalid __args__ 
Typically, the __args__ attribute of type annotations is a tuple
containing arguments for the types (ex. The __args__ of `List[int]` is
`(int,)`).  But some kind of types has non tuple __args__ attribute.
For example, `nptyping.NDArray` is one of them.

This fixes the TypeError when the invalid __args__ attribute found.
 2020-10-04 11:43:57 +09:00
Takeshi KOMIYA
d1f8dddeff Update CHANGES for PR #8277 2020-10-04 10:15:38 +09:00
Takeshi KOMIYA
3d92c02c37
Merge pull request #8277 from shimizukawa/fix-build-progress-spacing 
Fix: missing and redundant spacing (and etc) for console output on building
 2020-10-04 10:14:47 +09:00
shimizukawa
f0f90a5ce2 Fix: missing and redundant spacing (and etc) for console output on building. 
Before this fixing:
```
generating indices...  genindexdone
writing additional pages...  searchdone
copying static files... ... done
```

After this fixing:
```
generating indices... genindex done
writing additional pages... search done
copying static files... done
```

This tiny trouble has been introduced at #6538 (sphinx-2.0.0 Mar 29, 2019)
 2020-10-04 06:33:02 +09:00
Jakob Lykke Andersen
488f4a6ac4
Merge pull request #8275 from jakobandersen/cpp_fix_crash 
C++, properly reject functions as duplicates
 2020-10-03 16:27:12 +02:00
Jakob Lykke Andersen
777bcb43fa C++, properly reject functions as duplicates 
Fixes sphinx-doc/sphinx#8270
 2020-10-03 16:00:28 +02:00
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
178c05b059 Close #7996: manpage: Add man_make_section_directory 
Add a new config variable; man_make_section_directory to make a
section directory on build man page.  During 3.x, it defaults to
False and will be changed to True on 4.0 release.
 2020-10-03 22:30:20 +09:00
Jakob Lykke Andersen
6f5d45ffff C++, improve warning and debug messages 2020-10-03 15:20:41 +02: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
785f4d695c Fix #7964: autodoc: Tuple in default value is wrongly rendered 
This implements tuple literal support to sphinx.pycode.ast.unparse().
 2020-10-03 12:01:20 +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
Matthias Geier
786972e47f linkcheck: take source directory into account for local files 2020-09-27 20:54:50 +02: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
Jakob Lykke Andersen
94ce18205d
Merge pull request #8242 from jakobandersen/c_get_objects 
C, fix names in get_objects()
 2020-09-25 17:41:59 +02: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