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
17,404 Commits 2 Branches 219 Tags 163 MiB
742a2e0c0a
Commit Graph

17404 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
289d078350 Update CHANGES for PR #9079 2021-04-11 01:22:12 +09:00
Takeshi KOMIYA
1d1c813b01 Fix #9051: html theme: The style for figure are not applied 
Since docutils-0.17, figure directive starts to output `<figure>` tag.
To support it, this modifies CSS.
 2021-04-11 00:42:07 +09:00
Takeshi KOMIYA
deb603f3c5 Fix autodoc: Async staticmethods/ classmethods are considered as not async 
Since 3.10.0a7, the instances of staticmethod and classmethod have
`__wrapped__` attribute. It confuses sphinx.util.inspect:iscoroutinefunction().

refs:

* https://docs.python.org/3.10/whatsnew/3.10.html#other-language-changes
* https://bugs.python.org/issue43682
 2021-04-11 00:37:22 +09:00
Takeshi KOMIYA
7b97c8cba2 Update CHANGES for PR #9071 2021-04-10 19:28:27 +09:00
Takeshi KOMIYA
eb944064db
Merge pull request #9071 from ericholscher/pin-docutils 
Pin Sphinx 3.x to docutils <0.17
 2021-04-10 01:17:38 +09:00
Takeshi KOMIYA
36d6a66609
Merge pull request #9073 from hason/patch-1 
Depart method for node is optional
 2021-04-10 00:57:45 +09:00
Eric Holscher
025f26cd5d Pin Sphinx 3.x to docutils <0.17 
This will address the issues that the latest docutils release caused.
I think thi si a good practice in general to make sure we have a defined range of docutils versions,
given that they might change in the future.
Having this defined will mean that 3.x versions of Sphinx will always work,
even when docutils has advanced with additional backwards incompatible features.

Refs #9065 #9063 #9061 #9051
 2021-04-09 08:33:06 -07:00
Takeshi KOMIYA
fe6d95e429
Merge branch 'master' into patch-1 2021-04-10 00:32:26 +09:00
Martin Hasoň
7327e56dff
Depart method for node is optional 2021-04-09 12:44:10 +02:00
Merry Bass
ee9c7d33a1 fixup! sphinx.ext.extlinks: Allow `%s` in link caption string 
The old syntax will be deprecated in 4.x and 5.x and removed in Sphinx
6.0.
 2021-04-09 10:35:26 +00:00
Merry Bass
120daeea33 fixup! sphinx.ext.extlinks: Clarify escaping of `%` 2021-04-09 10:35:26 +00:00
Merry Bass
c39f147d44 sphinx.ext.extlinks: Clarify escaping of `%` 
We use Pythons %-formatting, so literal ``%`` must be escaped as ``%%``.
Clarify this behaviour for the caption and base URL strings.
 2021-04-09 12:24:15 +02:00
Takeshi KOMIYA
53d3c94d10 Update CHANGES for PR #9059 2021-04-09 01:42:41 +09:00
Takeshi KOMIYA
ffd243302a Fix #8870: Use title node for the caption of toctree 
Since docutils-0.17, the caption node should not use for the non-figure
nodes.  Therefore, this replaces it by the title node.
 2021-04-09 01:40:00 +09:00
Takeshi KOMIYA
ce5d66e618
Merge pull request #9053 from tk0miya/title_node_for_toctree_caption 
Fix #8870: Use title node for the caption of toctree
 2021-04-09 01:35:46 +09:00
Takeshi KOMIYA
dfc0a2879e Merge branch '3.x' 2021-04-09 01:04:06 +09:00
Takeshi KOMIYA
5604f9c420 Fix #8870: Use title node for the caption of toctree 
Since docutils-0.17, the caption node should not use for the non-figure
nodes.  Therefore, this replaces it by the title node.
 2021-04-09 01:02:29 +09:00
Takeshi KOMIYA
3ad1e5e7d1
Merge pull request #9064 from tk0miya/refactor_type_annotation 
refactor: Add Optional to type annotations
 2021-04-08 21:42:21 +09:00
Takeshi KOMIYA
01cac597e3
Merge pull request #9057 from tk0miya/refactor_vartypes 
refactor: Use PEP-526 based variable annotation
 2021-04-08 10:57:37 +09:00
Takeshi KOMIYA
d3f0de4e12 refactor: Add Optional to type annotations 2021-04-08 01:56:50 +09:00
Takeshi KOMIYA
eb68c237dd refactor: Use PEP-526 based variable annotation 2021-04-08 01:54:17 +09:00
Takeshi KOMIYA
245b3c32df
Merge pull request #9055 from tk0miya/refactor_type_annotation2 
refactor: use raw Type for type annotations
 2021-04-08 01:19:54 +09:00
Takeshi KOMIYA
8a3ea45f9a
Merge branch 'master' into refactor_type_annotation2 2021-04-08 00:48:15 +09:00
Takeshi KOMIYA
6781c66976
Merge pull request #9054 from tk0miya/refactor_docfields2 
refactor: Lazy loading is not needed for type annotations
 2021-04-08 00:47:20 +09:00
Takeshi KOMIYA
ea6c62a6c5
Merge pull request #9059 from mgeier/sidebar-css 
CSS: support for aside.sidebar (from docutils 0.17+)
 2021-04-07 23:46:40 +09:00
Matthias Geier
fa88bb2b83 CSS: support for aside.sidebar (from docutils 0.17+) 2021-04-07 15:55:54 +02:00
Takeshi KOMIYA
2f320c1a8d Update CHANGES for PR #8841 2021-04-04 18:04:51 +09:00
Takeshi KOMIYA
70ea4381ca
Merge pull request #8841 from AWhetter/autodoc_signatures_without_backslash 
Overloaded function signatures do not require a separating backslash
 2021-04-04 18:02:01 +09:00
Takeshi KOMIYA
1b0d4672a4 refactor: use raw Type for type annotations 2021-04-04 14:47:43 +09:00
Takeshi KOMIYA
8d3708a174 refactor: Lazy loading is not needed for type annotations 2021-04-04 14:29:36 +09:00
Takeshi KOMIYA
f7a2e081c8 Update CHANGES for PR #9036 2021-04-04 13:41:55 +09:00
Takeshi KOMIYA
fcb7d01422
Merge pull request #9036 from Blendify/patch-3 
HTML Templates: Add blocks to search page
 2021-04-04 13:36:48 +09:00
Takeshi KOMIYA
02016c0ef2 Close #8829: doc: Update description of paralle-read-safe 2021-04-04 13:35:12 +09:00
Takeshi KOMIYA
8d60b04844 Fix CI: NameError for missing docutils variable in test_build_html 2021-04-04 00:28:08 +09:00
Takeshi KOMIYA
41a377fee5 Merge branch '3.x' 2021-04-04 00:06:45 +09:00
Takeshi KOMIYA
8e258c0eb9 Merge branch '3.5.x' into 3.x 2021-04-04 00:05:46 +09:00
Takeshi KOMIYA
64b69ad565
Merge pull request #8870 from tk0miya/test_with_docutils0.17b1 
test: Do test with docutils-0.17b1
 2021-04-04 00:05:13 +09:00
Takeshi KOMIYA
cf2d11f947 test: Do test with docutils-0.17 (final) 2021-04-03 23:54:41 +09:00
Takeshi KOMIYA
a6d9b24a3b test: Update testcase for docutils-0.17 (toctree caption) 
Since v0.17, docutils starts to use <figcaption> for caption on HTML
output.  This modifies the expected value of our testcases to support
it.
 2021-04-03 23:54:19 +09:00
Takeshi KOMIYA
84b9d49826 test: Update testcase for docutils-0.17 (<section>) 
Since v0.17, docutils starts to use <section> for section on HTML
output.  This modifies the expected value of our testcases to support
it.
 2021-04-03 23:54:19 +09:00
Takeshi KOMIYA
6e438af6c0 test: Update testcase for docutils-0.17 (empty language) 
Since v0.17, docutils starts to load language module on parsing reST
document using StateMachine directly.  So far, our testcase uses invalid
language code for testing autosummary.  This fixes it to work with new
docutils.
 2021-04-03 23:54:19 +09:00
Takeshi KOMIYA
c2ee74f166 test: Update testcase for docutils-0.17 (<figure> and <figcaption>) 
Since v0.17, docutils starts to use <figure> and <figcaption> for figure
and its caption on HTML output.  This modifies the expected value of our
testcases to support it.
 2021-04-03 23:54:19 +09:00
Takeshi KOMIYA
26d0bb641b test: Do test with docutils-0.17b1 2021-04-03 23:54:19 +09:00
Takeshi KOMIYA
a476559abf Update CHANGES for PR #8539 2021-04-03 23:33:35 +09:00
Takeshi KOMIYA
ddb6e9c61c
Merge pull request #8539 from godlygeek/description_typehints_for_classes 
Make autodoc_typehints="description" work with autoclass_content="class"
 2021-04-03 23:28:08 +09:00
Takeshi KOMIYA
2b1d745c1b
Merge pull request #9035 from tk0miya/refactor_vartypes_search 
refactor: Use PEP-526 based variable annotation (sphinx.search)
 2021-04-03 14:13:16 +09:00
Takeshi KOMIYA
604faf5341
Merge pull request #9034 from tk0miya/refactor_vartypes_pycode 
refactor: Use PEP-526 based variable annotation (sphinx.pycode)
 2021-04-03 14:12:56 +09:00
Takeshi KOMIYA
3ac1c60c41
Merge pull request #9041 from albertvillanova/patch-1 
Fix typo in docs
 2021-04-03 14:09:49 +09:00
Takeshi KOMIYA
bdbabb14c2 Merge branch '3.x' 2021-04-03 13:22:21 +09:00
Takeshi KOMIYA
8dbacb1442 Merge branch '3.5.x' into 3.x 2021-04-03 13:22:06 +09:00