Commit Graph

3412 Commits

Author SHA1 Message Date
Takeshi KOMIYA
a843fd3db8 Close #7996: manpage: Make a section directory on build manpage by default 2020-10-28 02:15:36 +09:00
Takeshi KOMIYA
445b9515c1 Merge branch '3.x' 2020-10-24 18:12:45 +09:00
Takeshi KOMIYA
071b14884c Merge pull request #8303 from larsoner/tuple
TST: Add test
2020-10-24 17:52:22 +09:00
Takeshi KOMIYA
2a77eb07d0 Merge branch '3.x' into 3.2.x_to_3.x 2020-10-24 17:18:12 +09:00
Jakob Lykke Andersen
15251574a9 C, fix links to function parameters 2020-10-13 12:42:19 +02:00
Eric Larson
d10802fa6a TST: Add test 2020-10-07 14:25:24 -04:00
Takeshi KOMIYA
0476e1cea9 Merge pull request #8283 from tk0miya/7786_overloads_in_other_file
Fix #7786: autodoc: can't detect overloaded methods defined in other file
2020-10-06 01:33:22 +09:00
Takeshi KOMIYA
6dbe28a632 Fix #7786: autodoc: can't detect overloaded methods defined in other file 2020-10-05 22:49:05 +09:00
Takeshi KOMIYA
cc941db40b Fix #8255: py domain: number in defarg is changed to decimal
Number literals in default argument value is converted to decimal form
unexpectedly by AST module.  This fixes the signature parsing code to
recosntruct it correctly.

Note: This is only available in Python 3.8+.
2020-10-05 01:08:14 +09:00
Takeshi KOMIYA
0b32e72635 pycode: ast.unparse() construct number literals using source code
Developers can write number literals in several ways. For example,
decimal (1234), hexadecimal (0x1234), octal decimal (0o1234) and so on.
But, AST module don't mind how the numbers written in the code. As a
result, ast.unparse() could not reproduce the original form of number
literals.

This allows to construct number literals as possible using original
source code.

Note: This is only available in Python 3.8+.
2020-10-05 01:08:14 +09:00
Takeshi KOMIYA
598b85da75 Merge branch '3.x' into master 2020-10-04 22:41:44 +09:00
Takeshi KOMIYA
38bb377464 Merge pull request #8273 from sphinx-doc/7996_man_make_section_directory
Close #7996: manpage: Add man_make_section_directory
2020-10-04 22:40:41 +09:00
Takeshi KOMIYA
59d5f62160 Merge pull request #8070 from uktrade/stemmer-len3
Stemmer len3
2020-10-04 14:26:33 +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
3096b71c1c Merge branch '3.x' into 7964_tuple_in_signature 2020-10-04 11:53:41 +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
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
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
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
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
26ea870267 Merge branch '3.x' into master 2020-10-03 13:43:21 +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
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
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
b454d4e4b0 Merge branch '3.x' into 8190_autodoc-process-docstring-without_ending_blankline 2020-09-21 00:49:23 +09:00
Jakob Lykke Andersen
49e7400123 C, fix names in get_objects()
Fixes sphinx-doc/sphinx#8160
2020-09-14 21:16:15 +02:00
Takeshi KOMIYA
dfbe687db6 Merge branch '3.x' into 8103_cached_property 2020-09-13 11:07:33 +09:00
Takeshi KOMIYA
bec30596a8 Merge branch '3.x' into master 2020-09-13 10:54:21 +09:00
Takeshi KOMIYA
0b44e68d4f Merge branch '3.2.x' into 3.x 2020-09-13 10:51:15 +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
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
Juan Carrano
740be7f2a5 autodoc: blacklist typing.Generic.__new__
When documenting classes derived from typing.Generic (essentially all classes in the
typing module) the constructor signature would show an unhelpful (*args, **kwds).

typing.Generic has a __new__ method which was picked up by sphinx. With this patch it
is skipped and constructor signatures for generic classes are shown as they should.
2020-08-21 18:47:50 +02:00
Juan Carrano
642686159f autodoc: Test the signature of typing.Generic subclasses.
This test is currently failing because typing.Generic.__new__ clobbers the
real signature.
2020-08-21 18:47:14 +02:00
Takeshi KOMIYA
5ade6b7219 Merge branch '3.x' into master 2020-08-14 19:58:40 +09:00
Takeshi KOMIYA
d3af1cde2b Merge tag 'v3.2.1' into 3.x 2020-08-14 19:57:09 +09:00
Takeshi KOMIYA
d391212101 Merge branch '3.2.x' into 8099_NameError_for_TYPE_CHECKING 2020-08-14 14:37:19 +09:00
Takeshi KOMIYA
8412347f5d Merge branch '3.x' 2020-08-14 14:28:58 +09:00
Takeshi KOMIYA
b2d524d2b2 Merge branch '3.2.x' into 3.x 2020-08-14 14:24:11 +09:00
Takeshi KOMIYA
dab15e2857 Merge pull request #8058 from nijel/single-domain
i18n: Add support for having single text domain
2020-08-14 14:21:43 +09:00
Jakob Lykke Andersen
52140be6b8 C and C++, parsing function attributes
Fixes sphinx-doc/sphinx#8114
2020-08-13 18:39:28 +02:00
Jakob Lykke Andersen
d72fedb69d C++, fix template template parameter parsing
https://github.com/sphinx-doc/sphinx/pull/8037#issuecomment-673511490
2020-08-13 17:08:39 +02:00
Takeshi KOMIYA
088b049170 Fix #8103: autodoc: cached_property is not considered as a property
sphinx.util.inspect:isproperty() does not considers that
cached_property decorator that has been added since Python 3.8 is
a kind of properties.  This fixes it.
2020-08-13 23:16:59 +09:00
Takeshi KOMIYA
611fff975e Fix #8099: autodoc: NameError is raised when script uses TYPE_CHECKING
`typing.get_type_hints()` raises NameError when the target object
contains unresolavable type annotation (ex. TYPE_CHECKING).  This
handles the exception and use unresolved annotations for type hints.
2020-08-13 22:57:12 +09:00
Keewis
1c388241b4 default to False and update the tests 2020-08-12 19:48:07 +02:00
Keewis
27c252ccba only preprocess if the preprocessor is enabled 2020-08-10 13:04:21 +02:00