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,117 Commits 2 Branches 219 Tags
5fb6fb603965fe32ecbb45f408eea4060a979c28
Commit Graph

3900 Commits

Author SHA1 Message Date
Takeshi KOMIYA
5fb6fb6039 Fix #9651: autodoc_typehints_description_target was confused by :returns: 
It only checks the existence of `:return:` field.  And it does not check
`:returns:` field.  It causes the absence of return types.
 2021-09-26 02:10:13 +09:00
Takeshi KOMIYA
de59a72fe6 Merge pull request #9665 from tk0miya/9664_autodoc_process_bases_injection 
Close #9664: autodoc: autodoc-process-bases supports reST snippet
 2021-09-26 00:54:42 +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
d13b86e02f Close #9664: autodoc: autodoc-process-bases supports reST snippet 
This allows to inject a reST snippet through autodoc-process-bases
event.  It helps to modify the base classes of any class to the expected
mark-up'ed text by custom extension.
 2021-09-23 10:59:01 +09:00
Takeshi KOMIYA
506590d4ba Merge pull request #9640 from tk0miya/9639_support_asyncgenfunction 
Close #9639: autodoc: Support asynchronous generator functions
 2021-09-18 01:03:34 +09:00
Takeshi KOMIYA
ccfca458ea Close #9639: autodoc: Support asynchronous generator functions 2021-09-17 02:20:40 +09:00
Takeshi KOMIYA
ed227d7d3c Fix #9630: autodoc: Failed to build xrefs if primary_domain is not 'py' 
Autodoc generates reST code that uses raw `:obj:` and `:class:` xrefs to
refer the classes and types.  But they're fragile because they assume
the primary_domain=='py'.

This adds `:py:` prefix to these xrefs to make them robust.
 2021-09-14 23:59:47 +09:00
Takeshi KOMIYA
260f217a3d Merge pull request #9594 from hkuno/pr/no_empty_desc_4.x 
let user skip printing command description
 2021-09-11 19:08:37 +09:00
Takeshi KOMIYA
571929974a Add a testcase for #9694 2021-09-11 18:47:24 +09:00
Takeshi KOMIYA
c44ee0ebaa Merge pull request #9611 from tk0miya/9560_NewType_module 
Close #9560: autodoc: Allow to refer NewType with modname in py310+
 2021-09-11 17:19:54 +09:00
Christian Clauss
d2c95dfd0c overridden 2021-09-08 02:33:10 +02:00
Christian Clauss
86583c578c Fix typos discovered by codespell 2021-09-08 02:15:25 +02:00
Takeshi KOMIYA
c5b35efce3 Close #9560: autodoc: Allow to refer NewType with modname in py310+ 
Before 3.10, an instance of NewType has incorrect module name. But it
was fixed on 3.10.  This starts to use the module info if the
interpreter is 3.10+.
 2021-09-05 18:28:27 +09:00
Takeshi KOMIYA
bd5e40ce3a Merge pull request #9609 from tk0miya/9608_apidoc_pymod_definition_for_implicit_namespace 
Fix #9608: apidoc: module is not described if implicit namespace package
 2021-09-05 16:34:58 +09:00
Takeshi KOMIYA
a3f08fe298 Merge pull request #9606 from tk0miya/9600_typehints_including_commas 
Fix #9600: autosummary: Typehints including commas confuses autosummary
 2021-09-05 16:34:01 +09:00
Takeshi KOMIYA
223d615011 Fix #9608: apidoc: module is not described if implicit namespace package 
To make implicit namespace packages referencable, this outputs empty
module definitions for them.
 2021-09-04 22:44:04 +09:00
Takeshi KOMIYA
0a8655b733 Fix #9600: autosummary: Typehints including commas confuses autosummary 2021-09-04 01:54:11 +09:00
Takeshi KOMIYA
34664ce4ce Fix #9576: py domain: Literal typehint was converted to a cross reference 
The content of Literal typehint should not be converted to cross
references.
 2021-09-03 22:09:30 +09:00
Takeshi KOMIYA
3e24190564 Fix #9585: py:property directive does not create a hyperlink for types 2021-08-31 23:55:12 +09:00
Takeshi KOMIYA
a4a0b97835 Merge pull request #9569 from jakelishman/fix-autosummary-sections 
Fix #9568: autosummary: summarise overlined sectioned headings correctly
 2021-08-29 17:17:52 +09:00
Takeshi KOMIYA
760820f5ed Merge branch '4.x' into fix-autosummary-sections 2021-08-29 16:47:43 +09:00
Takeshi KOMIYA
276f943610 Merge branch '4.x' into 9564-fix_highlighted_code_role_smartquotes 2021-08-29 16:43:50 +09:00
Takeshi KOMIYA
95648432c4 Merge branch '4.1.x' into 4.x 2021-08-21 21:03:18 +09: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
Jakob Lykke Andersen
73c1520923 C++, fix parsing of defaulted fp function params 2021-08-20 18:17:42 +02:00
Jake Lishman
9d7fa75d4a Fix #9568: autosummary: summarise overlined sectioned headings correctly 
Add an extra step in the autosummary summariser algorithm to get a valid
text form of section headings.  This fixed issues when the first element
of a summarised document was a section heading with overlines, such as

    =======
    Heading
    =======

Previously, the first line would be taken verbatim, which caused parse
errors in the rest of the document.
 2021-08-20 17:05:58 +01:00
Jakob Lykke Andersen
4b62b6cb82 C, C++, parse <width> <complex/imaginary> 2021-08-20 17:15:34 +02:00
Jakob Lykke Andersen
a4371ea94c C++, update fundamental type handling a la in C 2021-08-20 17:15:34 +02:00
Jakob Lykke Andersen
cf091f7bb6 C, add short int, and treat spaced types properly 2021-08-20 17:15:34 +02:00
Jakob Lykke Andersen
e2ae287f1c C, add fract and accum 2021-08-20 17:15:34 +02:00
Jakob Lykke Andersen
c5962b70bd C, update fundamental types, including GNU exts 
Fixes sphinx-doc/sphinx#9535
 2021-08-20 17:15:34 +02:00
Takeshi KOMIYA
bde6c8d2ef Fix test: Tests has been broken with pygments-2.10+ 2021-08-19 23:26:42 +09:00
James
596ad5523d Merge branch '4.x' into 4.x 2021-08-02 00:32:14 +01:00
James
423b10a848 Add some tests 2021-08-02 00:20:08 +01: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
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
65c089bd40 Fix #9487: autodoc: typehint for cached_property is not shown 2021-07-22 23:25:03 +09: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
501abc67b6 Merge pull request #9478 from tk0miya/9443 
Fix testcases that failed in python3.10.0b4
 2021-07-20 00:39:43 +09:00
Takeshi KOMIYA
0565da6512 Fix testcases that failed in python3.10.0b4 2021-07-20 00:25:32 +09:00
James
451811c40c Respond to feedback 2021-07-18 10:55:38 +01: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
Takeshi KOMIYA
120525563c Cloase #9445: :py:property: directive now supports :classmethod: option 
Since python 3.9, `classmethod` starts to support creating a "class
property".  This allows to describe it.
 2021-07-17 14:24:31 +09:00
Karolina Surma
42d9d11247 Fix testcase: Enum changes were reverted in Python 3.10 2021-07-14 08:40:03 +02: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