Takeshi KOMIYA
d288907fd1
Merge branch '4.x' into 9607_incorrect_orig_bases
2021-09-27 02:21:14 +09:00
Takeshi KOMIYA
d75e3171cd
Merge pull request #9670 from jonppe/fix-download-file-with-special-characters
...
Fix download file with special characters
2021-09-25 14:38:48 +09:00
Johannes Aalto
fa3b334ed0
Add test for encoding local file links with special characters
...
Add test to make sure Sphinx uses proper URL encoding for
special characters in file names.
Use test_html_download() since it test_html5_output() doesn't
quite seem to have easy pattern to verify the contents of href
attribute.
Issue #3097
Signed-off-by: Johannes Aalto <ext-johannes.aalto@vaisala.com>
2021-09-24 20:34:09 +03:00
Takeshi KOMIYA
10b7f0e252
Fix #9607 : autodoc: Incorrect base class detection
...
In case of the descendants of generic class, the value of
obj.__orig_bases__ is incorrect because it returns original base
arguments for the child of the generic class instead of the target
class itself.
This uses obj.__dict__ to get the correct __orig_bases__ information.
2021-09-20 13:20:26 +09:00
Takeshi KOMIYA
ccfca458ea
Close #9639 : autodoc: Support asynchronous generator functions
2021-09-17 02:20:40 +09:00
Christian Clauss
86583c578c
Fix typos discovered by codespell
2021-09-08 02:15:25 +02:00
Justin Turner Arthur
adcda091d9
Check complete ancestry of text nodes for smartquotes eligibility.
...
Fixes sphinx-doc/sphinx#9564 .
2021-08-21 00:20:04 -05:00
Jeremy Maitin-Shepard
6c969ac87e
Fix autodoc_docstring_signature support for __init__ and __new__
...
The `MethodDocumenter.get_doc` method added by
51ae283a38
2021-07-31 09:32:40 -07:00
Takeshi KOMIYA
05cce83cc7
Merge branch '4.1.x' into 4.x
2021-07-23 02:16:33 +09:00
Takeshi KOMIYA
a35b009adc
Fix #9435 : linkcheck: Failed to check anchors in github.com
...
The approach of `rewrite_github_anchor` makes some anchors valid. But
it also makes other kind of anchors invalid. This disables the handler
to make them valid again (while 4.1.x release).
2021-07-18 13:03:57 +09:00
Takeshi KOMIYA
38d80c3d0f
Close #9445 : autodoc: Support class properties
...
Since python 3.9, `classmethod` starts to support creating a "class
property". This supports to generate document for it.
2021-07-17 16:39:50 +09:00
Simon Hausmann
3a50abc5c9
Fix handling of local paths in html_logo/html_favicon directorives in conf.py
...
Merge request #9381 broke support for local logos/favicons as it
retained the paths that are passed to the template engine. That's wrong
as the actual path will be in _static/.
This should fix #9438
2021-07-13 18:03:36 +02:00
Takeshi KOMIYA
f40c2837dc
Merge pull request #9225 from doerwalter/typehint-html
...
Add HTML markup to method/function return typehint
2021-07-11 12:03:40 +09:00
Eisuke Kawashima
652ebf1bf5
Fix typo
2021-07-08 08:16:22 +09:00
Takeshi KOMIYA
5e5bca98f7
Merge branch '4.x' into 6525_linkcheck_warn_redirects
2021-07-07 02:09:50 +09:00
David A. Ham
c218cf2192
Merge branch 'sphinx-doc:4.x' into container-latex
2021-07-04 20:24:49 +01:00
David Ham
52aac40148
Update tests to match code changes.
2021-07-04 20:15:56 +01:00
Takeshi KOMIYA
54c6c666c1
Merge pull request #9386 from tk0miya/9384_autodoc_typehints_supports_attributes
...
Fix #9384 : autodoc_typehints='none' supports typehints for attributes
2021-07-04 11:24:04 +09:00
Takeshi KOMIYA
2aef00d7bd
Fix #9384 : autodoc_typehints='none' supports typehints for attributes
2021-06-29 21:57:26 +09:00
Simon Hausmann
6a4c215cf0
Add unit test for remote logo and fav icon
2021-06-28 13:28:29 +02:00
Martin Liska
b23eefa03b
Fix :samp:{var} in manual pages.
...
When a samp begins with a variable part, it is not unwrapped for manual
pages.
Fixes #1860 .
2021-06-16 09:30:08 +02:00
Jakob Lykke Andersen
92c5ee07be
Merge pull request #9155 from jakobandersen/field_roles
...
Call roles in typed fields
2021-06-03 19:28:19 +02:00
Takeshi KOMIYA
1418e3acbb
Merge pull request #9260 from tk0miya/9016_linkcheck_github_anchors
...
Close #9016 : linkcheck builder failed to check the anchors of github.com
2021-06-04 01:18:22 +09:00
Jakob Lykke Andersen
783314d54d
Field roles, add C++ test
2021-06-03 16:52:38 +02:00
Jakob Lykke Andersen
27d40519c1
Field roles, add C test
2021-06-03 16:42:57 +02:00
Takeshi KOMIYA
69cbf7aa92
Merge pull request #9285 from tk0miya/9283_autodoc_attribute_not_having_comment
...
Fix #9283 : autodoc: failed to build doc for attribute not commented
2021-06-03 21:47:58 +09:00
Takeshi KOMIYA
90470b094e
Close #9268 : python_use_unqualified_type_names supports type field
2021-06-03 00:09:16 +09:00
Takeshi KOMIYA
92335bd6e6
Close #9016 : linkcheck builder failed to check the anchors of github.com
2021-06-01 00:31:15 +09:00
Takeshi KOMIYA
676834b998
Merge branch '4.x' into 6525_linkcheck_warn_redirects
2021-05-31 02:54:41 +09:00
Takeshi KOMIYA
9a9433e403
Fix #9283 : autodoc: failed to build doc for attribute not commented
...
Autoattribute directive should check the existence of instance attribute
that is defined inside __init__() but not having comments before
accessing it.
2021-05-30 19:48:11 +09:00
Walter Doerwald
798adc4f57
Add tests for html_signaturereturn_icon.
2021-05-22 20:15:11 +02:00
Takeshi KOMIYA
4201a84b35
Add testcase for combination of allow_redirects and warn_redirects
2021-05-21 02:04:01 +09:00
Takeshi KOMIYA
549f09e048
Merge pull request #9239 from igo95862/https-links
...
Upgrade URLs to use HTTPS
2021-05-19 22:59:19 +09:00
Takeshi KOMIYA
8049cd6925
Merge branch '4.0.x' into 4.x
2021-05-19 22:48:26 +09:00
Takeshi KOMIYA
2d3d668856
Fix #9240 : Unknown node error for pending_xref_condition is raised
...
Unknown node error for pending_xref_condition is raised if an extension
that does not support the node installs a missing-reference handler.
2021-05-18 01:55:36 +09:00
igo95862
e67c9e5df1
doc: Upgrade docutils.sourceforge.io links to HTTPS
...
Also change any docutils.sourceforge.net link to io
top level domain.
2021-05-16 15:53:49 +03:00
David Ham
180c3c92a4
Test for LaTeX container output.
2021-05-15 21:53:36 +01:00
Takeshi KOMIYA
4ceedc102d
Close #8061 , #9218 : autodoc: Support variable comment for alias classes
2021-05-15 16:31:40 +09:00
Takeshi KOMIYA
c341807991
Merge pull request #9185 from AWhetter/autodoc_typehints_both
...
autodoc.typehints can accurately represent overloads
2021-05-12 00:23:58 +09:00
Takeshi KOMIYA
71e732014f
Merge branch '4.0.x' into 4.x
2021-05-11 02:35:15 +09:00
Takeshi KOMIYA
4ab0dba755
Fix #9205 : py domain: canonical option causes xref resolution error
...
The :canonical: option causes "more than one target for
cross-reference" warning because the class having the same name is
registered.
2021-05-11 01:15:14 +09:00
Ashley Whetter
28d3f8136e
autodoc.typehints can accurately represent overloads
2021-05-08 21:34:25 -07:00
Takeshi KOMIYA
d69c35b1a4
Fix #9175 : autodoc: Special member is not documented in the module
...
The special members are not treated as "attributes". So they're not
handled by DataDocumenter. This moves the detection to the earlier
step of filter_members().
2021-05-08 17:33:33 +09:00
Takeshi KOMIYA
d82c8a7890
Merge pull request #9131 from RuRo/feature/glob-nitpick-ignore
...
Ignore nitpick warnings with regular expressions using `nitpick_ignore_regex`
2021-05-05 23:43:46 +09:00
Takeshi KOMIYA
1f860cb77e
Merge pull request #9146 from pbudzyns/autosummary-iattr-include
...
Autosummary to include instance attributes
2021-05-05 22:27:28 +09:00
Takeshi KOMIYA
f31af4b815
Merge branch '4.0.x' into 4.x
2021-05-03 22:31:51 +09:00
Takeshi KOMIYA
110fe1797c
Merge pull request #9159 from tk0miya/8588_nested_autodoc_type_aliases
...
Fix #8588 : autodoc_type_aliases does not support dotted name
2021-05-03 22:30:01 +09:00
Takeshi KOMIYA
30efa3d947
Merge branch '4.x' into 8597_metadata_only_docstring
2021-05-03 22:11:10 +09:00
Takeshi KOMIYA
caa6579dbd
Fix #8872 : autodoc: stacked singledispatches are wrongly rendered
...
When multiple singledispatch decorators are stacked, the first typehints
are copied to the subsequent definitions unexpectedly.
Now autodoc generates a dummy function not to affect typehints to
subsequent functions.
2021-05-03 21:51:19 +09:00
Takeshi KOMIYA
8d54010675
Fix test: deprecation warning for extlinks
2021-05-03 18:52:19 +09:00
