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
18,147 Commits 2 Branches 219 Tags 163 MiB
50dd03d640
Commit Graph

18147 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
f31d72c367 Update CHANGES for PR #9509 2021-08-01 16:18:57 +09:00
Takeshi KOMIYA
650730d9b2
Merge pull request #9515 from tk0miya/9504_SpecialForm 
Fix #9504: autodoc: generate incorrect reference to the parent class
 2021-08-01 15:13:27 +09:00
Takeshi KOMIYA
585869ac59 Merge branch '4.x' into 9479_autodoc_mocked_target 2021-08-01 15:12:37 +09:00
Takeshi KOMIYA
816f0746fe
Merge pull request #9519 from sphinx-doc/bot/pull-translations 
Update message catalogs
 2021-08-01 12:03:38 +09:00
tk0miya
531a7363c9 Update message catalogs 2021-08-01 00:09:22 +00:00
Takayuki SHIMIZUKAWA
723069d42b
fix issue template "How to Reproduce" doesn't render correctly 
remove unnecesary help-text in "value" instead of "description"
 2021-08-01 05:36:47 +09:00
Jeremy Maitin-Shepard
6c969ac87e Fix autodoc_docstring_signature support for __init__ and __new__ 
The `MethodDocumenter.get_doc` method added by
51ae283a38 prevents
DocstringSignatureMixin from working correctly for __init__ and
__new__ methods.  Additionally, the __new__ docstring was not obtained
correctly.

This commit checks for `self._new_docstrings` being set, and also
corrects the logic for obtaining the __new__ docstring.

There still remains the issue that when the class signature is
obtained from the signature of __init__ or __new__, only the real
signature is used, due to the use of `sphinx.util.inspect.signature`;
the autodoc_docstring_signature option does not have any effect.
 2021-07-31 09:32:40 -07:00
Takeshi KOMIYA
155ca3e853 Update CHANGES for PR #9509 2021-07-31 02:44:05 +09:00
Takeshi KOMIYA
e344c3b718
Merge pull request #9509 from yanyongyu/bugfix/get-type-hints 
[autodoc] Fix uncatched exception in get type hints
 2021-07-31 02:41:34 +09:00
Takeshi KOMIYA
d0c97e9eb5 Fix #9504: autodoc: generate incorrect reference to the parent class 
Autodoc generates incorrect references to the parent class the target
class inherites the class having `_name` attribute.  It conciders the
parent is a kind of SpecialForm'ed class by mistake.  This uses
`isinstance(X, SpecialForm)` to check that.

Note: SpecialForm became a class since Python 3.7.
 2021-07-31 01:41:35 +09:00
yanyongyu
4cceeae766 Merge branch '4.x' into bugfix/get-type-hints 2021-07-30 01:44:50 +08:00
Takeshi KOMIYA
ee612ffdeb Merge branch '4.1.x' into 4.x 2021-07-30 02:19:41 +09:00
Takeshi KOMIYA
1fd5f74653 Fix #9512: sphinx-build: crashed with the HEAD of Python 3.10 
Recently, `types.Union` was renamed to `types.UnionType` on the HEAD
of 3.10 (refs: python/cpython#27342). After this change, sphinx-build
has been crashed because of ImportError.
 2021-07-30 02:19:29 +09:00
Takeshi KOMIYA
36e06d67c9
Merge pull request #9513 from tk0miya/9512_types.UnionTypes 
Fix #9512: sphinx-build: crashed with the HEAD of Python 3.10
 2021-07-30 02:18:34 +09:00
Takeshi KOMIYA
8b2031c747 Fix #9512: sphinx-build: crashed with the HEAD of Python 3.10 
Recently, `types.Union` was renamed to `types.UnionType` on the HEAD
of 3.10 (refs: python/cpython#27342). After this change, sphinx-build
has been crashed because of ImportError.
 2021-07-30 01:32:28 +09:00
yanyongyu
67fb3d1157 Fix uncatched exception in get type hints 2021-07-29 12:03:03 +08:00
Takeshi KOMIYA
a7daa19a93 Fix #9479: autodoc: Emit a warning if target is a mocked object 2021-07-27 23:55:26 +09:00
Takeshi KOMIYA
216e16a701
Merge branch '4.x' into 9456_abbr_marks_on_search_result 2021-07-27 02:18:06 +09:00
Takeshi KOMIYA
f59026865a
Merge pull request #9498 from tk0miya/9481_autosummary_warnings 
Fix #9481: autosummary: some warnings contain non-existing filenames
 2021-07-27 02:17:39 +09:00
Takeshi KOMIYA
2d9e696104 Merge branch '4.1.x' into 4.x 2021-07-27 02:15:59 +09:00
Takeshi KOMIYA
f210e4541a Bump version 2021-07-27 02:15:05 +09:00
Takeshi KOMIYA
4ba5c21b01 Bump to 4.1.2 final 2021-07-27 02:13:32 +09:00
Takeshi KOMIYA
52fd229dda Merge branch '4.1.x' into 4.x 2021-07-26 01:26:27 +09:00
Takeshi KOMIYA
4dc45f0a3d
Merge pull request #9494 from tk0miya/9456_revert_9129 
Fix #9456: html search: html_copy_source can't control the search summaries
 2021-07-26 01:26:08 +09:00
Takeshi KOMIYA
df562b4343
Merge branch '4.1.x' into 9456_revert_9129 2021-07-26 00:57:21 +09:00
Takeshi KOMIYA
774b0b05b6 Fix #9481: autosummary: some warnings contain non-existing filenames 
`SphinxDirective.get_source_info()` returns the pair of fullpath of
source and current line number.  But our logging module expects one of
these:

* A string consists of fullpath and current line number
* A pair of docname and current line number

To show correct location for warnings, this adds `get_location()` method
that returns the former one.

Note: This also modifies C/C++ domains.
 2021-07-25 20:04:18 +09:00
Takeshi KOMIYA
5d8f925e02
Merge pull request #9493 from tk0miya/9436_autodoc_class_signature 
Fix #9436, #9471: autodoc: crashed if autodoc_class_signature = "separated"
 2021-07-25 19:08:53 +09:00
Takeshi KOMIYA
ebb03cd1fb
Merge pull request #9497 from sphinx-doc/bot/pull-translations 
Update message catalogs
 2021-07-25 11:42:59 +09:00
tk0miya
853aaa153e Update message catalogs 2021-07-25 02:36:19 +00:00
Takeshi KOMIYA
175301218d Fix #9456: html search: abbreation marks are inserted to the search 2021-07-24 21:53:57 +09:00
Takeshi KOMIYA
ef53dec9c5 Fix #9456: html search: html_copy_source can't control the search summaries 
This reverts commit 634b05f3a5.

So far, users can disable showing summary texts via `html_copy_source`
setting.  But this change always show them forcedly.  To keep
compatibility, it should be reverted temporarily.

refs: #9456
 2021-07-24 21:09:29 +09:00
Takeshi KOMIYA
07598f0d6f
Merge pull request #9492 from sphinx-doc/9486_autoproperty_docs 
doc: Add document for autoproperty directive (refs: #9486)
 2021-07-24 18:09:38 +09:00
Takeshi KOMIYA
43528da015
Merge pull request #9488 from tk0miya/9487_typehint_for_cached_property 
Fix #9487: autodoc: typehint for cached_property is not shown
 2021-07-24 18:09:00 +09:00
Takeshi KOMIYA
4f364a30bc Fix #9436, #9471: autodoc: crashed if autodoc_class_signature = "separated" 
A list should be used for special-members option instead of set.
 2021-07-24 14:52:25 +09:00
Takeshi KOMIYA
fe47bf46cb
Merge pull request #9470 from lmmx/4.x 
Reviewed all docstrings to improve readability and correctness
 2021-07-24 11:07:19 +09:00
Louis Maddox
10dba797f2 Address flake8 errors in whitespace linting 2021-07-23 21:53:46 +01:00
Louis Maddox
f89f787cc9
Merge branch 'sphinx-doc:4.x' into 4.x 2021-07-23 21:35:40 +01:00
Takeshi KOMIYA
6e87c17a76 doc: Add document for autoproperty directive (refs: #9486) 2021-07-23 23:10:48 +09:00
Takeshi KOMIYA
3dd562ad6a Merge branch '4.x' into 9487_typehint_for_cached_property 2021-07-23 02:22:38 +09:00
Takeshi KOMIYA
05cce83cc7 Merge branch '4.1.x' into 4.x 2021-07-23 02:16:33 +09:00
Takeshi KOMIYA
9218ad4adc
Merge pull request #9491 from tk0miya/9489_NewType 
Bugfix for HEAD of python-3.10
 2021-07-23 02:14:58 +09:00
Takeshi KOMIYA
68fb54806f Fix #9490: autodoc: Some typing.* objects are broken 
At the HEAD of 3.10, the implementation of `typing._SpecialForm` and
`typing._BaseGenericAlias` has been changed to support __qualname__.
 2021-07-23 02:04:26 +09:00
Takeshi KOMIYA
771507e073 Fix #9489: autodoc: Custom types using typing.NewType are broken 
At the HEAD of 3.10, the implementation of ``typing.NewType`` has been
changed to the class based.  To follow the change, this uses
``isinstance`` on ``sphinx.util.inspect:isNewType()`.
 2021-07-23 00:06:33 +09:00
Takeshi KOMIYA
65c089bd40 Fix #9487: autodoc: typehint for cached_property is not shown 2021-07-22 23:25:03 +09:00
Louis Maddox
a2310d0f94 Fix nits after review by tk0miya; merge HEAD 2021-07-19 22:35:30 +01:00
Louis Maddox
5ae46cb388
Merge branch 'sphinx-doc:4.x' into 4.x 2021-07-19 22:28:38 +01:00
Takeshi KOMIYA
9ebdc987b0
Merge pull request #9467 from tk0miya/9435_disable_rewrite_github_anchor 
Fix #9435: linkcheck: Failed to check anchors in github.com
 2021-07-20 01:15:29 +09:00
Takeshi KOMIYA
f9941b9402
Merge pull request #9464 from Gobot1234/4.x 
Add support for PEP 585 generics
 2021-07-20 01:14:12 +09:00
Takeshi KOMIYA
362f36d35d
Merge pull request #9461 from tk0miya/9445_class_property 
Close #9445: Support class properties
 2021-07-20 01:12:04 +09:00
Takeshi KOMIYA
445c340cbd
Merge pull request #9474 from jfbu/latex_document_9166 
LaTeX: add some documentation for container support (#9166)
 2021-07-20 01:00:28 +09:00