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,563 Commits 2 Branches 219 Tags 163 MiB
59cb7466b5
Commit Graph

18563 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
85efe39c55
Merge pull request #9910 from kianmeng/fix-typos 
Fix typos
 2021-12-04 11:46:13 +09:00
Takeshi KOMIYA
4d176d4564
Merge pull request #9928 from joukewitteveen/patch-1 
doc: Fix autodoc extension example
 2021-12-04 11:08:46 +09:00
Takeshi KOMIYA
c71ff1cd21 Close #9075: autodoc: Add a config variable autodoc_unqualified_typehints 
If autodoc_unqualified_typehints feature enabled, autodoc suppresses the
leading module names of typehints of function signatures (ex.
`io.StringIO` -> `StringIO`)
 2021-12-03 18:05:49 +09:00
Takeshi KOMIYA
5aa6cbbca8 Add unqualified_typehints parameter to stringify_signature() 
To make the generated function signatures simple, this adds a new
parameter `unqualified_typehints` to sphinx.util.inspect:
stringify_signature() to suppress the leading module name of
typehints.
 2021-12-03 18:05:49 +09:00
Takeshi KOMIYA
80f79aef91 Add smartref parameter to sphinx.util.typing:stringify() 
To make the generated function signatures simple, this adds a new
parameter `smartref` to sphinx.util.typing:stringify() to suppress the
leading module name from typehints.
 2021-12-03 18:05:49 +09:00
Jakob Lykke Andersen
aabf772722 Prevent literal line wrapping 2021-12-02 18:01:27 +01:00
Jouke Witteveen
bc849e2170
doc: Fix autodoc extension example 
`directivetype` is set to mimic `ClassDocumenter`. Reflect that.

`isinstance` would work on the enum members, but that is not what we want here.
`issubclass` raises a TypeError when called on objects that are not classes.
 2021-12-02 16:50:09 +01:00
Jakob Lykke Andersen
f8f26286ad C, simple type specifier parsing, handling macro-keywords 2021-12-01 19:33:23 +01:00
Jakob Lykke Andersen
c09643c21f C, fix parsing of fundamental types 
When multiple simple type specifiers are part of the type,
then they may appear in any order.
 2021-11-30 22:00:54 +01:00
Jakob Lykke Andersen
67d673406f C++, fix parsing of fundamental types 
When multiple simple type specifiers are part of the type,
then they may appear in any order.
 2021-11-30 22:00:20 +01:00
Jakob Lykke Andersen
355147e893 C++, fix typo in internal function 2021-11-30 21:59:24 +01:00
Jakob Lykke Andersen
17dfa81107
Merge pull request #9914 from jakobandersen/cpp-typo 
Fix typo in C++ domain
 2021-11-30 18:59:50 +01:00
Jakob Lykke Andersen
ed79004e42 C++, fix typo in internal function 2021-11-30 18:35:39 +01:00
Kian-Meng, Ang
5161341b3e Fix typos 2021-11-30 05:48:44 +08:00
Takeshi KOMIYA
e188d38e9d
Merge pull request #9908 from tk0miya/remove_debug_print 
Fix autodoc: Remove debug print
 2021-11-30 02:03:28 +09:00
Takeshi KOMIYA
5eaed2bed7 py domain: Allow "~" prefix as a prefix of typehints in signature 
Now python domain supports the "~" prefix at the beginning of the
typehints of the function signatures:

  .. py:function:: func(x: ~typing.Dict)

It's rescognized as the same as python reference roles do
(ex. :py:class:`~typing.Dict`).
 2021-11-30 01:54:23 +09:00
Takeshi KOMIYA
a3edc982c1
Merge pull request #9902 from tk0miya/9899_pydomain_crossref_specifier_in_typefield 
Fix #9899: py domain: Allows cross-reference specifier to :type: option
 2021-11-30 01:43:51 +09:00
Takeshi KOMIYA
4f622f33d4
Merge pull request #9906 from tk0miya/9800_extlinks_adjust_priority 
extlinks: Adjust priority (refs: #9800)
 2021-11-30 01:38:54 +09:00
Takeshi KOMIYA
c115eb5ea7
Merge branch '4.x' into remove_debug_print 2021-11-30 01:38:18 +09:00
Takeshi KOMIYA
e8e45a3678
Merge pull request #9905 from tk0miya/9883_ismock 
Fix #9883: autodoc: doccomment for the alias to mocked object was ignored
 2021-11-30 01:37:41 +09:00
Takeshi KOMIYA
e25589ca1d
Merge branch '4.x' into 9899_pydomain_crossref_specifier_in_typefield 2021-11-30 01:37:04 +09:00
Takeshi KOMIYA
3812a42942 extlinks: Adjust priority (refs: #9800) 2021-11-29 10:11:36 +09:00
Takeshi KOMIYA
472abb0876 Update CHANGES 2021-11-29 10:11:14 +09:00
Takeshi KOMIYA
8dc095e7c1 Fix autodoc: Remove debug print 
A message is shown on building document using NewTypes with Python
3.10.
 2021-11-29 10:11:14 +09:00
Takeshi KOMIYA
a7462d57b4
Merge pull request #9907 from tk0miya/9800_fix_lint_error 
Fix flake8 and isort errors (refs: #9800)
 2021-11-29 10:10:42 +09:00
Takeshi KOMIYA
558f54a2b4 Fix flake8 and isort errors (refs: #9800) 2021-11-29 09:42:20 +09:00
Takeshi KOMIYA
3fa146078b Sort CHANGES entries 2021-11-29 09:38:18 +09:00
Takeshi KOMIYA
74d912133a
Merge pull request #9800 from hoefling/extlinks/replacements-check 
Proposal: check if hardcoded URLs can be replaced with extlinks
 2021-11-29 09:36:55 +09:00
Juan Luis Cano Rodríguez
f6a3d037f4
Remove note to simplify message 2021-11-28 19:58:30 +01:00
Takeshi KOMIYA
f88ac53e51 Fix #9883: autodoc: doccomment for the alias to mocked object was ignored 2021-11-29 02:06:16 +09:00
Takeshi KOMIYA
acaf70596e Fix #9899: py domain: Allows cross-reference specifier to :type: option 2021-11-29 00:32:56 +09:00
Takeshi KOMIYA
f8420c7787
Merge pull request #9901 from tk0miya/label_for_transifex_pr 
Add i18n label to weekly transifex PR
 2021-11-28 13:42:01 +09:00
Takeshi KOMIYA
17422d2227 Add i18n label to weekly transifex PR 2021-11-28 13:27:36 +09:00
Takeshi KOMIYA
f4181e79d0
Merge pull request #9900 from tk0miya/docutils-0.18.1 
test: Try to import nodes.meta first (for the latest docutils)
 2021-11-28 13:22:50 +09:00
Takeshi KOMIYA
4236017a3d
Merge pull request #9898 from sphinx-doc/bot/pull-translations 
Update message catalogs
 2021-11-28 13:05:06 +09:00
Takeshi KOMIYA
17467b7ae2 test: Try to import nodes.meta first (for the latest docutils) 2021-11-28 13:01:50 +09:00
tk0miya
15c506b86b Update message catalogs 2021-11-28 00:11:57 +00:00
Takeshi KOMIYA
f780210b6a Merge branch '4.3.x' into 4.x 2021-11-28 01:08:34 +09:00
Takeshi KOMIYA
95969a47e5 Bump version 2021-11-28 01:07:36 +09:00
Takeshi KOMIYA
ad3f23e256 Bump to 4.3.1 final 2021-11-28 01:04:37 +09:00
Takeshi KOMIYA
a5d1c22512
Merge pull request #9890 from tk0miya/9844_preserve_defaults_for_partial 
Fix #9844: autodoc: Failed to preserve defvalues for partial function
 2021-11-27 13:00:34 +09:00
Takeshi KOMIYA
2b0ba5089b Merge remote-tracking branch 'origin/4.x' into 4.x 2021-11-26 02:55:56 +09:00
Takeshi KOMIYA
f2295d2f07 Merge branch '4.3.x' into 4.x 2021-11-26 02:55:41 +09:00
Takeshi KOMIYA
15d834e4d8
Merge pull request #9831 from Yoshanuikabundi/autosummary___all__ 
Allow autosummary to respect __all__
 2021-11-26 02:15:43 +09:00
Takeshi KOMIYA
aa0335acde
Merge pull request #9886 from tk0miya/9868_pytest_failing 
Fix #9868: 4.3.0: pytest is failing
 2021-11-26 02:08:18 +09:00
Takeshi KOMIYA
3d88424c74 Fix #9844: autodoc: Failed to preserve defvalues for partial function 2021-11-26 02:04:11 +09:00
Takeshi KOMIYA
dbba0ae7de Fix #9868: imgmath: Crashed if the dvisvgm command failed to convert equation 2021-11-23 18:39:14 +09:00
Takeshi KOMIYA
c8f019ab50 Fix #9868: ImportError on testing sphinx.util.inspect 
In some Linux distribution, ImportError is raised on testing
sphinx.util.inspect because _testcapi is not installed.
 2021-11-23 18:22:08 +09:00
Takeshi KOMIYA
259de307ca Merge branch '4.3.x' into 4.x 2021-11-23 18:17:13 +09:00
Juan Luis Cano Rodríguez
d39c6861d9 Add note about .nojekyll file 2021-11-23 10:17:09 +01:00