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,162 Commits 2 Branches 219 Tags
51e7b6d2aa871c262e37f3fc9edbef67a2b3edd2
Commit Graph

5396 Commits

Author SHA1 Message Date
Jakob Lykke Andersen
a6246c1b65 Typo fixes 2021-10-01 20:48:12 +02:00
Jakob Lykke Andersen
91d0289009 C++, add retval info field to cpp:function 2021-10-01 20:47:14 +02:00
Jakob Lykke Andersen
8ed9ebc939 C, add CHANGES entry for sphinx-doc/sphinx#9691 2021-10-01 17:47:08 +02:00
Takeshi KOMIYA
0424210614 Update CHANGES for PR #9678 2021-10-01 02:42:16 +09:00
Takeshi KOMIYA
c1f8afafe1 Merge pull request #9687 from tk0miya/9500_latexpdf_on_windows 
Fix #9500: LaTeX: Failed to build Japanese document on Windows
 2021-09-30 18:35:53 +09:00
Takeshi KOMIYA
3cde4871d3 Fix #9500: LaTeX: Failed to build Japanese document on Windows 
At present, LaTeX builder generates a Makefile for PDFLaTeX instead of
upLaTeX in building Japanese document on Windows.  This adds upLaTeX
support to Makefile for Windows.
 2021-09-30 18:00:57 +09:00
Takeshi KOMIYA
d288907fd1 Merge branch '4.x' into 9607_incorrect_orig_bases 2021-09-27 02:21:14 +09:00
Takeshi KOMIYA
0ea135e6d4 Merge branch '4.x' into 9657_qualname_of_mock 2021-09-27 01:58:44 +09:00
Takeshi KOMIYA
232dbe41c5 Merge pull request #9673 from tk0miya/9651_autodoc_typehints_description_target 
Fix #9651: autodoc_typehints_description_target was confused by :returns:
 2021-09-27 01:58:10 +09:00
Takeshi KOMIYA
72e5090403 Merge pull request #9649 from jakobandersen/searchindex_fix 
Searchindex fix when objects have the same name
 2021-09-27 01:54:50 +09:00
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
5fb51fb146 Merge pull request #9668 from tk0miya/9655_mocked_object_having_doccomment 
Fix #9655: autodoc: mocked object having doc comment is warned unexpectedly
 2021-09-26 00:55:10 +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
Jakob Lykke Andersen
cfc802048b search, update CHANGES 2021-09-25 11:02:24 +02:00
Jakob Lykke Andersen
b6e60d4993 search, store objects as array to retain all 2021-09-25 10:59:49 +02:00
Takeshi KOMIYA
699d03f597 Update CHANGES for PR #9670 2021-09-25 14:39:50 +09:00
Takeshi KOMIYA
bdc2112dbc Fix #9655: autodoc: mocked object having doc comment is warned unexpectedly 
A warning for mocked object should not be emitted if it has doc comment.
 2021-09-24 02:04:25 +09: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
e79efef63a Fix #9657: autodoc: basecls for a subclass of mocked object is incorrect 2021-09-21 02:03:31 +09: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
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