Commit Graph

15928 Commits

Author SHA1 Message Date
pbudzyns
35adeeff41 update docs 2021-02-01 10:28:01 +01:00
pbudzyns
8d380cadc7 check if autodoc_defaults are str, fix tests 2021-02-01 09:46:19 +01:00
pbudzyns
dc277e0e18 code format 2021-01-29 10:41:16 +01:00
pbudzyns
b76187a6e5 add private-members as extendable 2021-01-29 10:36:35 +01:00
pbudzyns
28a37c2936 local options handling 2021-01-29 10:34:05 +01:00
pbudzyns
ac5079ed85 redundant '+' has no effect 2021-01-25 16:07:18 +01:00
pbudzyns
381e30c23b add more extendable options and tests 2021-01-25 13:24:01 +01:00
pbudzyns
7348ba8d60 add more extendable options and tests 2021-01-25 13:15:13 +01:00
pbudzyns
0a85b4148e add more extendable options and tests 2021-01-25 12:54:08 +01:00
root
6f78f0b164 local exclude-members option fix 2020-10-06 08:39:13 +02: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
c82d1c76e1
Merge pull request #8281 from tk0miya/8073_update_directive_example
docs: Fix an example for add_directive()
2020-10-06 00:49:17 +09:00
Takeshi KOMIYA
ca87e47b7d
Merge pull request #8280 from tk0miya/refactor_add_source_parser
refactor: Change signature of app.add_source_parser()
2020-10-06 00:48:37 +09:00
Takeshi KOMIYA
dd7c50f366
Merge pull request #8279 from tk0miya/8073_add_docs_for_override_flag
docs: Add documentation for "override" flag of app API
2020-10-06 00:48:10 +09:00
Takeshi KOMIYA
408ebe4105
Merge pull request #8278 from tk0miya/8255_hexadecimal_default_value
Fix #8255: py domain: number in defarg is changed to decimal
2020-10-06 00:47:22 +09:00
Takeshi KOMIYA
2371be5376
Merge pull request #8288 from francoisfreitag/outdated_comment
Outdated comment in docs config for intersphinx
2020-10-05 23:14:55 +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
François Freitag
bd49c3c2ef
Outdated comment in docs config for intersphinx
Intersphinx is in use since 6a396c7eb8.
2020-10-05 08:34:26 +02: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
a8abb9995f
Merge pull request #8274 from tk0miya/8200_typealias_break_type_annotation
Fix #8200: autodoc: type aliases break type formatting
2020-10-04 23:44:08 +09:00
Takeshi KOMIYA
d8cdad919b
Merge branch '3.x' into 8200_typealias_break_type_annotation 2020-10-04 22:55:42 +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
f2d8093632
Merge pull request #7978 from tk0miya/7973_imgconverter_warnings
Fix #7973: imgconverter: Check availability of imagemagick many times
2020-10-04 17:27:07 +09:00
Takeshi KOMIYA
941c9ba23d Update CHANGES for PR #8245 2020-10-04 17:18:38 +09:00
Takeshi KOMIYA
837a4d1173
Merge pull request #8245 from mgeier/linkcheck-sourcedir
linkcheck: take source directory into account for local files
2020-10-04 17:17:33 +09:00
Takeshi KOMIYA
45717977ac Fix #7973: imgconverter: Check availability of imagemagick only once
To prevent checking the availability of image converters times and times
again, this stores the result to the class variable.  It is not a good
design to have a state globally.  So this should be refactored in the
future.
2020-10-04 17:16:18 +09:00
Matthias Geier
6b3d445879 Pass docname instead of srcdir 2020-10-04 10:02:57 +02:00
Takeshi KOMIYA
0f6522e5d1
Merge pull request #8076 from tk0miya/6914_wrong_numfig
Fix #6914: figure numbers are unexpectedly assigned to uncaptioned items
2020-10-04 15:52:13 +09:00
Takeshi KOMIYA
66dda1fc50 Fix #6914: figure numbers are unexpectedly assigned to uncaptioned items
The figure numbers should be assigned to items only having captions or
titles.  This uses `get_numfig_title()` to ensures it on assign numbers.
2020-10-04 14:32:56 +09:00
Takeshi KOMIYA
7b395f6b25 docs: Fix an example for add_directive() 2020-10-04 14:22:02 +09:00
Takeshi KOMIYA
129e09c6e3 refactor: Change signature of app.add_source_parser()
To make compatible with old versions, app.add_source_parser() have taken
two types of arguments.  But the compatibility was no longer needed
since 3.0.  So it would be better to use clearer signature.
2020-10-04 14:15:43 +09:00
Takeshi KOMIYA
7f7a207626 docs: Add documentation for "override" flag of app API 2020-10-04 14:13:03 +09:00
Takeshi KOMIYA
b4add96a53
Merge pull request #8266 from tk0miya/deprecate_singledispatchfunctiondocumenter
autodoc: deprecate SingledispatchFunctionDocumenter
2020-10-04 14:11:25 +09:00
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
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
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