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,775 Commits 2 Branches 219 Tags 163 MiB
99e36398fc
Commit Graph

15775 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
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
Matt from Documatt
db9375363c Add link to third party themes on GitLab 
GitLab, alternative to GitHub, also contains a lot of beautiful open source themes.
 2020-08-07 14:46:19 +02:00
Keewis
79a2471032 add a create_documenter method wrapping get_documenter 2020-08-07 14:17:45 +02:00
Keewis
78e4499435 revert the dispatcher changes 2020-08-07 14:10:12 +02:00
Takeshi KOMIYA
e4e9a0f4be Update CHANGES for PR #7799 2020-08-06 11:01:52 +09:00
Takeshi KOMIYA
64a26ff4de
Merge pull request #7799 from keewis/escape-combined-args-kwargs 
Escape combined args kwargs
 2020-08-06 10:59:21 +09:00
Takeshi KOMIYA
9c55630018 Update CHANGES for PR #8048 2020-08-06 10:57:43 +09:00
Takeshi KOMIYA
a8032b4405
Merge pull request #8048 from cjmayo/graphviz 
Don't copy graphviz.css when building man pages
 2020-08-06 10:56:27 +09:00
Chris Mayo
71e9a15ccf Don't copy graphviz.css when building man pages 
_static/graphviz.css is being created alongside the man pages.
 2020-08-05 20:05:49 +01:00
Takeshi KOMIYA
f743be0054
Merge pull request #8047 from cjmayo/typos 
Assorted typos including sphinx-buid in internationalization figure
 2020-08-06 02:38:07 +09:00
Keewis
849d3c18a7 remove the syntax checks from the escape method and update the tests 2020-08-05 19:22:43 +02:00
Takeshi KOMIYA
784e7636d9
Merge pull request #8025 from tk0miya/6698_no-trim-flags 
Close #6698: doctest: Add :trim-flags: and :no-trim-flags: options
 2020-08-06 00:29:36 +09:00
Takeshi KOMIYA
059dc108ba Close #6698: doctest: Add :no-trim-doctest-flags: options 
To control trimming doctest flags manually, this adds new options
:trim-doctest-flags: and :no-trim-doctest-flags: to doctest
directives.  It helps to describes doctest module itself in python
doc (see #6698).
 2020-08-05 23:39:05 +09:00
Keewis
e79cd79cd2 revert the change to DocFieldTransformer 2020-08-05 14:28:32 +02:00
Keewis
478ab44d7e Merge branch '3.x' into escape-combined-args-kwargs 2020-08-04 18:38:03 +02:00
Takeshi KOMIYA
fcf63a20cd
Merge pull request #8021 from keewis/fix-type-preprocessor 
Fix type preprocessor
 2020-08-05 00:19:29 +09:00
Keewis
47da37e1d9 make sure strings are not split using other delimiters 2020-08-04 12:28:30 +02:00
Keewis
fbad78d08f check that a "default <obj>" notation works with xrefs 2020-08-04 12:21:00 +02:00
Keewis
af7d6a5be8 only allow "default <obj>" and "default: <obj>" for now 2020-08-04 12:20:09 +02:00
Keewis
cb61f0f734 document that we don't require use_param = True anymore 2020-08-04 11:39:48 +02:00
Keewis
cac6d1787d preprocess even with napoleon_use_param = False 2020-08-04 10:43:31 +02:00