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
15,692 Commits 2 Branches 219 Tags 163 MiB
cac6d1787d
Commit Graph

15692 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Keewis
cac6d1787d preprocess even with napoleon_use_param = False 2020-08-04 10:43:31 +02: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
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
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
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
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
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
Takeshi KOMIYA
a99675bf78 Fix #8008: py domain: failed to parse a type annotation containing ellipsis 
Fix _parse_annotation() does not support a type annotation having ellipsis.
 2020-07-30 01:48:25 +09:00
Takeshi KOMIYA
bb65ea7930 Update CHANGES for PR #7994 2020-07-30 00:37:44 +09:00
Takeshi KOMIYA
c3943e31cf
Merge pull request #7994 from utzig/option-compat-id 
Add option to use old node-ids in option directive
 2020-07-30 00:35:06 +09:00
Takeshi KOMIYA
376d4fe4c6 Update CHANGES for PR #8017 2020-07-29 23:30:09 +09:00
Chris Holdgraf
b8ee3ac9a4 moving extension dev overview 2020-07-29 10:38:18 +01:00
Chris Holdgraf
84f7dffd99 comments 2020-07-29 10:38:18 +01:00
Chris Holdgraf
c7085162d1 rearranging a few docs and small updates 2020-07-29 10:38:18 +01:00
Chris Holdgraf
924befa07e Update doc/development/tutorials/builders.rst 2020-07-29 10:38:18 +01:00
Chris Holdgraf
729dcd0e03 flake8 2020-07-29 10:38:18 +01:00
Chris Holdgraf
60b105d6aa several documentation improvements to theming, templating, and extension development 2020-07-29 10:38:18 +01:00
Takeshi KOMIYA
cc73965016
Merge pull request #8017 from jschueller/partialinit 
Fix circular import in addnodes.py
 2020-07-29 02:04:38 +09:00
Julien Schueller
cefdb566eb Fix circular import in addnodes.py 
Closes #8016
 2020-07-28 11:44:46 +02:00
Fabio Utzig
d65c61f9e7 Add compat id for cmdoption directive 
Add a compatibility id for the option directive, which avoids breaking
old html links to anchors.

Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
 2020-07-27 16:07:14 -03:00
Jakob Lykke Andersen
2cf3e7cae2
Merge pull request #8014 from jakobandersen/utzig-named-variadic-arg 
C, named variadic arg
 2020-07-27 19:51:17 +02:00
Jakob Lykke Andersen
1b3bf4e319 C, changelog and test for named variadic args 2020-07-27 19:42:58 +02:00
Takeshi KOMIYA
3f4a6d61ab
Merge pull request #8012 from utzig/fix-sphinxtranslator-typo 
Fix typo
 2020-07-28 01:08:46 +09:00
Fabio Utzig
8c08abadee Fix typo 
Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
 2020-07-27 10:11:39 -03:00
Takeshi KOMIYA
09ca58d0dd Fix #7768: i18n: Wrong root element is passed to figure_language_filename 
The root element should be a user specified path; a relative path from
current document or absolute path based on source directory.  But an
absolute path is passed instead.
 2020-07-26 13:53:09 +09:00
Takeshi KOMIYA
ff4330abe3 Update CHANGES for PR #7992 2020-07-26 12:27:43 +09:00
Takeshi KOMIYA
08912dd2c4
Merge pull request #7992 from jobec/3.x 
Allow searching for things like serials, phone numbers, etc
 2020-07-26 12:25:59 +09:00