Commit Graph

15875 Commits

Author SHA1 Message Date
Chris Mayo
9bac86a2fc Fix typo sphinx-buid in internationalization figure 2020-08-03 19:30:38 +01:00
Chris Mayo
fe4a158caf Fix typos in the documentation 2020-08-03 19:30:38 +01:00
Takeshi KOMIYA
a721631a54
Merge pull request #8043 from tk0miya/refactor_autodoc
refactor autodoc: Documenter.filter_members()
2020-08-03 22:34:11 +09:00
Takeshi KOMIYA
281647b657
Merge pull request #8044 from tk0miya/refactor_test_ext_autodoc
refactor: test: Rename target.enum to target.enums
2020-08-03 22:33:46 +09:00
Keewis
c4dc1b39d3 Merge branch '3.x' into custom-get_documenter 2020-08-02 22:21:19 +02:00
Takeshi KOMIYA
c0157cf074 refactor: test: Rename target.enum to target.enums
Using "enum" for module name bothers me on debugging errors because
it sometimes raises ImportError.
2020-08-03 02:30:30 +09:00
Keewis
2a3f6e4d70 don't try to split along ', ' 2020-08-02 19:28:01 +02:00
Takeshi KOMIYA
59f68baddd refactor: autodoc: Check special-member or not using regexp 2020-08-03 01:59:53 +09:00
Takeshi KOMIYA
46f0b3063d refactor: autodoc: Add EMPTY that matches to no members
Add a special class `_Empty` to make the comparison of
:exclude-members: option simply.  It never matches to any members.
2020-08-03 01:59:53 +09:00
Takeshi KOMIYA
a9e0c4b515 refactor: autodoc: ALL matches to any members
Add a special class `_All` to make the comparison of :*-members: option
simply.  Now it matches to any members.
2020-08-03 01:58:35 +09:00
Takeshi KOMIYA
57af828882
Merge pull request #8035 from tk0miya/8034_argument_for_private-members
Close #8034: autodoc: :private-member: can take an list of member names
2020-08-03 01:57:13 +09:00
Keewis
95897349b9 fix the calls of the custom documenter functions 2020-08-02 15:53:47 +02:00
Keewis
95cb391bcf actually use it as a method 2020-08-02 14:48:14 +02:00
Keewis
7bbcc3e07b Merge branch '3.x' into custom-get_documenter 2020-08-02 14:46:35 +02:00
Keewis
83905c61b0 convert to a method 2020-08-02 14:41:13 +02:00
Keewis
2bdaa6c23e implement the dispatching 2020-08-02 14:05:36 +02:00
Keewis
c212f5842c allow registering custom get_documenter functions 2020-08-02 14:05:09 +02:00
Takeshi KOMIYA
5be006124e
Merge pull request #8033 from tk0miya/8032_typehint_for_ivar_on_parentclass
Fix #8032: autodoc: A typehint for inherited ivars is not shown
2020-08-02 19:24:25 +09:00
Takeshi KOMIYA
5d301b44b9 Fix #8032: autodoc: A typehint for inherited ivars is not shown
This tries to import the parent object for the instance attribute
to get type annotations for the variable.
2020-08-02 18:27:03 +09:00
Takeshi KOMIYA
cc25bac264
Merge pull request #8031 from tk0miya/8030_annotated_ivar_isnt_shown_with_inherited_members
Fix #8030: autodoc: An annotated instance variable is not documented
2020-08-02 18:25:22 +09:00
Takeshi KOMIYA
03a6028663
Merge pull request #8028 from tk0miya/8011_ivar_for_autosummary
Close #8011: autosummary: Support instance attributes
2020-08-02 18:24:32 +09:00
Jakob Lykke Andersen
89df9a18d2
Merge pull request #8037 from jakobandersen/cpp_template_nontype
C++, fix non-type template parameter parsing
2020-08-02 11:22:45 +02:00
Jakob Lykke Andersen
a99039b13b C++, fix non-type template parameter parsing
Fixes sphinx-doc/sphinx#7944
2020-08-02 10:34:51 +02:00
Takeshi KOMIYA
0cfb433b25
Merge pull request #8026 from tk0miya/7768_docpath_for_figure_language_filename
Close #7768: i18n: figure_language_filename supports {docpath} token
2020-08-02 16:43:54 +09:00
Takeshi KOMIYA
af15593c0c Close #7768: i18n: figure_language_filename supports {docpath} token
To build structured i18n imaging directory, figure_language_filename
now supports `{docpath}` token that is a dirname of the current
document.
2020-08-02 16:28:54 +09:00
Takeshi KOMIYA
4f56fad7b7
Merge pull request #7986 from mgeier/css-highlight-selector
basic CSS: fix "highlight-" selector
2020-08-02 12:03:54 +09:00
Matthias Geier
416438366d Update CHANGES for PR #7986 2020-08-01 20:17:42 +02:00
Matthias Geier
c5180a6d3f basic CSS: fix "highlight-" selector 2020-08-01 20:15:32 +02:00
Takeshi KOMIYA
d7a84e83cc Close #8034: autodoc: :private-member: can take an list of member names
Now :private-member: option can take an explicit list of member names to
be documented as its arguments (like :special-members: does).
2020-08-02 01:27:14 +09:00
Takeshi KOMIYA
6225ffd238 Fix #8030: autodoc: An annotated instance variable is not documented
Documenter.filter_members() have wrongly considered that an instance
variable not having a docstring should be skipped when
`:inherited-members:` option given.

This fixes the behavior when the instance variable has annotated.

Note: This doest not still detect well for not annotated instance
variables.
2020-08-01 22:05:12 +09:00
Keewis
6be806b3c8 check that floats and complex numbers are detected as literals 2020-08-01 14:20:04 +02:00
Keewis
92e9cd488c use a regex to decide whether to postprocess a token starting with default 2020-08-01 13:38:38 +02:00
Keewis
3ff956c27a Merge branch '3.x' into fix-type-preprocessor 2020-08-01 13:26:11 +02:00
Keewis
02ff1cc290 use a upper-case name for the list of singleton names 2020-08-01 13:25:28 +02:00
Keewis
ccd24aa00f use complex to check for numerical values 2020-08-01 13:21:17 +02:00
Keewis
5ee6a03ca7 detect ... as a link 2020-08-01 13:21:17 +02:00
Keewis
a09c170808 skip whitespace only tokens 2020-08-01 13:21:17 +02:00
Takeshi KOMIYA
92e863fb24 Close #8011: autosummary: Support instance attributes
This allows the autosummary directive to take instance attributes to
build documents for them.
2020-08-01 19:19:18 +09:00
Takeshi KOMIYA
5e6da19f0e
Merge pull request #8027 from tk0miya/8032_evaluate_signature_in_py39
Fix #8023: evaluate_signature() does not work properly in python3.9
2020-08-01 18:07:03 +09:00
Takeshi KOMIYA
76e12a59ff Fix #8023: evaluate_signature() does not work properly in python3.9
Since 3.9b5, ForwardRef._evalute() also takes an additional argument
`recursive_guard`.  As a result, sphinx.util.inspect:evaluate_signature()
does not work properly.  This adds a simple wrapper evalute_forwardref()
to allow evaluating ForwardRefs in py3.9.
2020-08-01 17:59:02 +09:00
Takeshi KOMIYA
6084c44b50
Merge pull request #7995 from tk0miya/7993_texinfo_for_nested_desc
Fix #7993: texinfo: TypeError is raised for nested object descriptions
2020-08-01 16:50:42 +09:00
Takeshi KOMIYA
f71b26ac56
Merge branch '3.x' into 7993_texinfo_for_nested_desc 2020-08-01 15:50:55 +09:00
Takeshi KOMIYA
2644199e7e
Merge pull request #8024 from tk0miya/8032_evaluate_signature_in_py310
Fix #8023: evaluate_signature() does not work properly in python3.10
2020-08-01 13:22:29 +09:00
Takeshi KOMIYA
01ff500b34 Fix #8023: evaluate_signature() does not work properly in python3.10
Since 3.10, ForwardRef._evalute() takes an additional argument
`recursive_guard`.  As a result, sphinx.util.inspect:evaluate_signature()
does not work properly.  This adds a simple wrapper evalute_forwardref()
to allow evaluating ForwardRefs in py3.10.
2020-08-01 13:06:09 +09:00
Keewis
b353dfed7b properly link ... to Ellipsis 2020-07-31 17:44:04 +02:00
Takeshi KOMIYA
a443538e0c
Merge pull request #8006 from tk0miya/7768_root_for_figure_language_filename
Fix #7768: i18n: Wrong root element is passed to figure_language_filename
2020-07-31 02:04:17 +09:00
Takeshi KOMIYA
6031fe63b8
Merge pull request #8020 from tk0miya/8008_support_ellipsis_in_typehints
Fix #8008: py domain: failed to parse a type annotation containing ellipsis
2020-07-31 02:00:46 +09:00
Keewis
31809b3041 add tests for referencing ellipsis objects 2020-07-29 22:30:02 +02:00
Keewis
e39c1a8d6a add more delimiters so describing mappings becomes possible 2020-07-29 22:29:03 +02:00
Keewis
05bf00bd4c make the postprocessing a bit more robust and add tests 2020-07-29 22:23:51 +02:00