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,105 Commits 2 Branches 219 Tags
d13b86e02fc22ca29bd06a57151afad77b81e832
Commit Graph

5377 Commits

Author SHA1 Message Date
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
3774c124f8 Update CHANGES for PR #9644 2021-09-18 01:21:13 +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
bc012076b8 Fix #9630: autosummary: Failed to build summary table if primary_domain is not 'py' 
Autosummary generates reST code that uses raw `:obj:` xrefs to refer
the python objects in the summary table.  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
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
ba2439a105 Bump version 2021-09-12 16:55:46 +09:00
Takeshi KOMIYA
cf38356a08 Bump version 2021-09-12 16:54:59 +09:00
Takeshi KOMIYA
21db4b1407 Bump to 4.2.0 final 2021-09-12 16:51:24 +09:00
Takeshi KOMIYA
2390ce6e1a CHANGES: Merge 4.1.3 (unreleased) to 4.2.0 2021-09-12 16:48:25 +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
fb141c355f Update CHANGES for PR #9594 2021-09-11 18:54:29 +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
Takeshi KOMIYA
3a67b49f5d Update CHANGES for PR #9617 2021-09-11 17:12:59 +09: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
6fb8d1c806 Merge branch '4.x' into 9524_SphinxTestApp_outdir 2021-08-29 23:18:56 +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
e33134f6ba Merge pull request #9590 from tk0miya/9589_Annotated 
Fix #9589: autodoc: typing.Annotated has wrongly been rendered
 2021-08-29 16:02:08 +09:00
Takeshi KOMIYA
b82d3ef05a Fix #9589: autodoc: typing.Annotated has wrongly been rendered 
At the HEAD of 3.10, the implementation of `typing.Annotated` has
been changed to have __qualname__.
 2021-08-29 15:51:39 +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
a4371ea94c C++, update fundamental type handling a la in C 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
a4b540f61f Close #9524: test: SphinxTestApp can take `builddir` as an argument 2021-08-15 02:45:32 +09:00
Takeshi KOMIYA
3e5729b057 Fix #9267: html theme: CSS and JS files added by theme were loaded twice 2021-08-14 21:10:56 +09:00
Takeshi KOMIYA
75c86c3059 Merge branch '4.1.x' into 4.x 2021-08-11 02:10:49 +09:00
Takeshi KOMIYA
648af37d86 Fix #9537: autodoc: Some typing.* objects are broken 
At the HEAD of 3.10, the implementation of `typing._GenericAlias` has
been changed to have correct _name and __name__.
 2021-08-11 01:59:38 +09:00
Takeshi KOMIYA
a7ac325a1b Update CHANGES for PR #9522 2021-08-05 01:54:28 +09:00
Takeshi KOMIYA
d788e78a5e Update CHANGES for PR #9447 2021-08-02 02:10:46 +09:00
Takeshi KOMIYA
efea26f7d1 Merge pull request #9495 from tk0miya/9456_abbr_marks_on_search_result 
Fix #9456: html search: abbreation marks are inserted to the search
 2021-08-02 01:35:35 +09:00
Takeshi KOMIYA
33f70bea87 Merge branch '4.x' into 9479_autodoc_mocked_target 2021-08-02 00:28:15 +09:00
Takeshi KOMIYA
383eff0ced Update CHANGES for PR #9518 2021-08-02 00:27:18 +09:00
Takeshi KOMIYA
f31d72c367 Update CHANGES for PR #9509 2021-08-01 16:18:57 +09:00
Takeshi KOMIYA
585869ac59 Merge branch '4.x' into 9479_autodoc_mocked_target 2021-08-01 15:12:37 +09:00
Takeshi KOMIYA
155ca3e853 Update CHANGES for PR #9509 2021-07-31 02:44:05 +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
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
Takeshi KOMIYA
a7daa19a93 Fix #9479: autodoc: Emit a warning if target is a mocked object 2021-07-27 23:55:26 +09:00