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
16,108 Commits 2 Branches 219 Tags 163 MiB
10e11f3133
Commit Graph

16108 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
harupy
2a632598c3 fix 2020-08-14 00:48:41 +09:00
harupy
2f971a61f3 Color pytest output log 2020-08-14 00:41:17 +09: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
1bca9f9587 Close #8100: html: Show a better error message for html_static_files 
The HTML Builder crashes if error raised on copying html_static_files.
This handles the exception and show a better error message to let users
the reason of errors (ex. failed on extracting Jinja templates).
 2020-08-14 00:07:01 +09:00
Takeshi KOMIYA
088b049170 Fix #8103: autodoc: cached_property is not considered as a property 
sphinx.util.inspect:isproperty() does not considers that
cached_property decorator that has been added since Python 3.8 is
a kind of properties.  This fixes it.
 2020-08-13 23:16:59 +09: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
4baa7ce99b Update CHANGES for PR #8102 2020-08-13 01:53:30 +09:00
Takeshi KOMIYA
22820d841e
Merge pull request #8102 from yves-chevallier/location 
Use current node location in case of error (related to #8093)
 2020-08-13 01:50:59 +09: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
Yves Chevallier
53a82a5630 Use node as location 2020-08-12 16:29:26 +02: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
38b868cc0d
Merge pull request #8085 from tk0miya/8084_KeyError_for_broken_class 
Fix #8084: autodoc: KeyError is raised on documenting a broken attribute
 2020-08-10 14:46:33 +09:00
Takeshi KOMIYA
24f690c9e5
Merge branch '3.x' into 8084_KeyError_for_broken_class 2020-08-10 14:23:49 +09:00
Takeshi KOMIYA
6cf1301c9e Remove pylint task 
At present, pylint has no longer been used in this project. This
removes the tasks and files for pylint from repository.
 2020-08-10 13:20:06 +09:00
Takeshi KOMIYA
e4a55cb76f
Merge pull request #8080 from yves-chevallier/check-latex-packages 
[Feature] Check if LaTeX package already added
 2020-08-09 23:49:02 +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
f916e1d5c8
Merge pull request #8082 from yves-chevallier/jinja-comment-tag 
Customize jinja comment-tag
 2020-08-09 22:55:38 +09:00
Yves Chevallier
5f82825e27 Customize jinja comment-tag 2020-08-09 13:33:42 +02:00
Yves Chevallier
a4487f1762 Check if LaTeX package already added 2020-08-09 12:12:24 +02:00
Takeshi KOMIYA
a01acc4e1c
Merge pull request #8077 from tk0miya/8074_napoleon_crashes_by_cython 
Fix #8074: napoleon: Crashes during processing C-ext module
 2020-08-09 14:31:16 +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
Michal Čihař
1bf7fe424e i18n: Add support for having single text domain 
The gettext_compact can now be a string which is then a single domain
for all documents.

Fixes #784
 2020-08-07 20:22:30 +02: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
Keewis
b69c5119b5 Merge branch '3.x' into preprocess-other-sections 2020-08-07 16:56:00 +02: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