Commit Graph

15795 Commits

Author SHA1 Message Date
Jakob Lykke Andersen
777bcb43fa C++, properly reject functions as duplicates
Fixes sphinx-doc/sphinx#8270
2020-10-03 16:00:28 +02:00
Jakob Lykke Andersen
6f5d45ffff C++, improve warning and debug messages 2020-10-03 15:20:41 +02: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
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
b5dc3adf66
Merge pull request #8205 from tk0miya/test_with_pygments270
Fix our test failed with pygments-2.7.0
2020-09-13 10:50:50 +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
Jakob Lykke Andersen
59766c2351 Update CHANGES after PR 2020-09-12 14:33:57 +02:00
Jakob Lykke Andersen
46a6b0848b
Merge pull request #8188 from utzig/fix-c-domain-intersphinx
domains: c: add missing intersphinx object types
2020-09-12 14:32:01 +02:00
Fabio Utzig
8c4193027b domains: c: add missing intersphinx object types
For intersphinx to be able to resolve references to C-Domain objects, it
needs to have them declared in the obj_types dict. This is currently
missing enum, enumerator, struct and union so those can't be referenced
by an external project. This commit fixes the issue by adding them.

Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
2020-09-09 09:46:46 -03:00
Jakob Lykke Andersen
07374d95c1
Merge pull request #8187 from utzig/fix-typos
domains: c: cpp: fix typos
2020-09-09 14:24:27 +02:00
Fabio Utzig
8d882e4737 domains: c: cpp: fix typos
Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
2020-09-09 08:33:12 -03:00
Takeshi KOMIYA
fabe685638 Bump version 2020-08-14 19:55:41 +09:00
Takeshi KOMIYA
3597942810 Bump to 3.2.1 final 2020-08-14 19:53:48 +09:00
Takeshi KOMIYA
5d70682dda
Merge pull request #8108 from tk0miya/8099_NameError_for_TYPE_CHECKING
Fix #8099: autodoc: NameError is raised when script uses TYPE_CHECKING
2020-08-14 14:56:00 +09:00
Takeshi KOMIYA
d391212101
Merge branch '3.2.x' into 8099_NameError_for_TYPE_CHECKING 2020-08-14 14:37:19 +09:00
Jakob Lykke Andersen
90e9b31a16
Merge pull request #8117 from jakobandersen/c_cpp_function_attributes
C and C++, parsing function attributes
2020-08-13 19:45:52 +02: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
667a188e25
Merge pull request #8113 from jakobandersen/cpp_template_template
C++, fix template template parameter parsing
2020-08-13 17:29:18 +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
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
Takeshi KOMIYA
99e36398fc Update CHANGES for PR #8095 2020-08-13 22:38:57 +09:00
Takeshi KOMIYA
6e62d33566
Merge pull request #8095 from keewis/toggle-preprocessor
add a setting to enable / disable the numpy type preprocessor
2020-08-13 22:35:36 +09:00
Keewis
1c388241b4 default to False and update the tests 2020-08-12 19:48:07 +02:00
Takeshi KOMIYA
e70a30e5a3
Merge pull request #8092 from tk0miya/8085_AttributeError_on_get_type_hints
Fix #8091: autodoc: AttributeError is raised on documenting an attribute
2020-08-12 23:31:53 +09:00
Keewis
be65bded76 fix a typo 2020-08-10 23:10:27 +02:00
Keewis
27c252ccba only preprocess if the preprocessor is enabled 2020-08-10 13:04:21 +02:00
Keewis
2d180e49c2 add a setting to disable the type preprocessor 2020-08-10 13:03:50 +02:00
Takeshi KOMIYA
bb09f92154 Fix #8091: autodoc: AttributeError is raised on documenting an attribute
Until Python 3.5.2, typing.get_type_hints() raises AttributeError if
given object does not have `__code__` attribute.  This handles the
exception not to crash building documents.

Note: The AttributeError was fixed at 3.5.3
refs: 991d14fee1
2020-08-10 16:24:13 +09:00
Takeshi KOMIYA
bf26080042 Merge branch '8084_KeyError_for_broken_class' into 3.2.x 2020-08-10 16:06:28 +09:00
Takeshi KOMIYA
f7431b927c Fix #8084: autodoc: KeyError is raised on documenting a broken attribute
``typing.get_type_hints()`` raises KeyError when a class having invalid
__module__ was given.  This handles the exception not to crash on build
documents.
2020-08-09 23:43:01 +09:00
Takeshi KOMIYA
51332c7b08 Fix #8074: napoleon: Crashes during processing C-ext module
inspect.getfile() raises TypeError if given object is a C-extension.
This handles the exception not to be crashed.
2020-08-09 00:46:30 +09:00
Takeshi KOMIYA
40bdeb2c16 Bump version 2020-08-08 18:13:51 +09:00
Takeshi KOMIYA
0ff74155df Bump version 2020-08-08 18:13:03 +09:00
Takeshi KOMIYA
e91f8a7d05 Bump to 3.2.0 final 2020-08-08 18:09:52 +09:00
Takeshi KOMIYA
b4efb8cd0e Merge CHANGES of 3.1.3 (unreleased) to 3.2.0 2020-08-08 18:09:08 +09:00
Takeshi KOMIYA
5fd89964c5 Update CHANGES for PR #8071 2020-08-08 17:15:09 +09:00
Takeshi KOMIYA
b2d3f06621
Merge pull request #8071 from asmeurer/self-reference-warning-type
Make the toc.circular suppress_warnings flag apply to self referenced toctrees
2020-08-08 17:13:53 +09:00
Aaron Meurer
2a59fbcdbe
Make the toc.circular suppress_warnings flag apply to self referenced toctrees
Fixes https://github.com/sphinx-doc/sphinx/issues/7410#issuecomment-670678193.
2020-08-07 15:42:41 -06:00
Takeshi KOMIYA
f92fa6443f
Merge pull request #8038 from keewis/custom-get_documenter
register custom autosummary get_documenter functions
2020-08-08 01:15:20 +09:00
Takeshi KOMIYA
697dff31ab
Merge pull request #8042 from tk0miya/8041_ivar_on_superclass_not_shown
Fix #8041: autodoc: An ivar on super class is not shown unexpectedly
2020-08-08 00:51:46 +09:00
Takeshi KOMIYA
88b2ec6c34 Fix #8041: autodoc: An ivar on super class is not shown unexpectedly
An annotated instance variable on super class is not documented when
derived class has also other annotated instance variables because
`obj.__annotations__` is overrided by derived class's type hints.

To get annotations of the target class correctly, this scans MRO to
get all of annotated instance variables.
2020-08-08 00:21:29 +09:00
Takeshi KOMIYA
5aa774b97a
Merge pull request #8056 from tk0miya/7780_multi_params_in_numpydoc
Fix #7780: napoleon: multiple params declaration was wrongly recognized
2020-08-07 23:58:11 +09:00
Takeshi KOMIYA
16e62c57e9
Merge pull request #8065 from tk0miya/8049_update_testcase
napoleon: Fix a broken test (refs: #8049)
2020-08-07 23:54:05 +09:00
Takeshi KOMIYA
a4996f9054 Fix #7780: napoleon: multiple params declaration was wrongly recognized
So far, napoleon converts multiple paramaters declrarations to single
paramaeter fields (`:param:` and `:type:`) unexpectedly.  As a result,
the output seems broken.

This converts it to multiple parameter fields (a pair of field for each
parameter declration) to build parameter successfully.

Note: The conversion rule is available only when napoleon_use_params=True.
2020-08-07 23:46:55 +09:00
Takeshi KOMIYA
99e65a59be napoleon: Fix a broken test (refs: #8049)
Fix a testcase that added just before #8049 merged.
2020-08-07 23:44:32 +09:00
Takeshi KOMIYA
e188d56ed1 Update CHANGES for PR #8049 2020-08-07 23:40:11 +09:00
Takeshi KOMIYA
62a6df8f3c
Merge pull request #8049 from keewis/type-preprocessing-without-use_param
enable type preprocessing without use_param
2020-08-07 23:37:22 +09:00
Keewis
b4dec34ecf update the type hint 2020-08-07 15:41:17 +02:00
Keewis
9d60f3456f return a documenter instance instead of just the class 2020-08-07 15:32:11 +02:00
Takeshi KOMIYA
92a134b419
Merge pull request #8064 from mattdocumatt/3.x
Add link to third party themes on GitLab
2020-08-07 22:23:15 +09:00