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,330 Commits 2 Branches 219 Tags 163 MiB
d0d06923eb
Commit Graph

17330 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
d0d06923eb Bump version 2021-04-12 00:30:49 +09:00
Takeshi KOMIYA
4a328f41a5 Bump to 4.0.0 beta1 2021-04-12 00:29:49 +09:00
Takeshi KOMIYA
04565936a9 Update CHANGES for PR #8898 2021-04-11 22:18:01 +09:00
Merry Bass
93cf1a57d9 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-11 22:14:55 +09:00
Merry Bass
75605d437f fixup! sphinx.ext.extlinks: Clarify escaping of `%` 2021-04-11 22:14:24 +09:00
Merry Bass
ef1747f03a 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-11 22:14:17 +09:00
Merry Bass
fb39974486 sphinx.ext.extlinks: Allow `%s` in link caption string 
Tweak syntax of extlinks to also allow ``%s`` in the link caption part.
Like for the base URL ``%s`` will be substituted with the content of the
role.  This allows configurations like

    extlinks = {'quarter': ('https://example.org/quaters/%s',
                          '%s. quarter')}

with ``:quarter:`2``` getting replaced by a link titled `2. quarter`.

The requirement for the caption string is to be either None or contain
exactly one ``%s``.  If neither is the case, then we emit a warning and
fall back to the old behaviour which is concatenating the caption string
with the role content.
 2021-04-11 22:14:01 +09:00
Takeshi KOMIYA
081e717c91 Merge branch '3.x' 2021-04-11 22:13:16 +09:00
Takeshi KOMIYA
1423924923 Merge branch '3.5.x' into 3.x 2021-04-11 22:12:57 +09:00
Takeshi KOMIYA
9238dd89ac Revert "Merge pull request #8898 from merrybass/feature-extlinks-pattern" 
This reverts commit cd83daa967, reversing
changes made to c58cea9afa.
 2021-04-11 22:10:22 +09:00
Takeshi KOMIYA
cd83daa967
Merge pull request #8898 from merrybass/feature-extlinks-pattern 
sphinx.ext.extlinks: Allow ``%s`` in link caption string
 2021-04-11 22:09:06 +09:00
Takeshi KOMIYA
42a1bcf2c7 test: Skip test for py310-dev 2021-04-11 20:43:05 +09:00
Takeshi KOMIYA
8a5cb89714 Merge branch '3.x' 2021-04-11 20:30:40 +09:00
Takeshi KOMIYA
1c6df11a8d Merge branch '3.5.x' into 3.x 2021-04-11 20:29:11 +09:00
Takeshi KOMIYA
1cc969ec29 Merge branch 'disable_test_with_py310' into 3.5.x 2021-04-11 20:28:46 +09:00
Takeshi KOMIYA
694664ca6e Bump version 2021-04-11 20:28:18 +09:00
Takeshi KOMIYA
f6a839ff0f Bump to 3.5.4 final 2021-04-11 20:27:10 +09:00
Takeshi KOMIYA
c58cea9afa
Merge pull request #9083 from tk0miya/disable_test_with_py310 
test: Disable testing with python3.10
 2021-04-11 20:00:02 +09:00
Takeshi KOMIYA
8602e64214 test: Disable testing with python3.10 
pytest has crashed on testing with python 3.10.0a7. To avoid the error,
this disables testing with python3.10 for a while.
 2021-04-11 19:49:28 +09:00
Takeshi KOMIYA
dda888abd5
Merge pull request #9077 from tk0miya/9051_figure_style 
Fix #9051: html theme: The style for figure are not applied
 2021-04-11 19:17:17 +09:00
Takeshi KOMIYA
6365c0e9bd
Merge pull request #9081 from tk0miya/test_with_docutils 
Fix CI for docutils
 2021-04-11 19:16:51 +09:00
Takeshi KOMIYA
9a7ed23e44 test: docutils-0.13 is no longer supported. Skip using in CI 2021-04-11 12:44:51 +09:00
Takeshi KOMIYA
2308a2fffa test: Test with the bugfixed version of each docutils release 2021-04-11 12:44:04 +09:00
Takeshi KOMIYA
9263eea383 Merge branch '3.x' 2021-04-11 02:22:32 +09:00
Takeshi KOMIYA
1df14a4828 Merge branch '3.5.x' into 3.x 2021-04-11 02:17:55 +09:00
Takeshi KOMIYA
b7dedec4f7
Merge branch '3.5.x' into 9051_figure_style 2021-04-11 02:10:41 +09:00
Takeshi KOMIYA
43dc09175f
Merge pull request #9079 from tk0miya/9078_async_staticmethod 
Fix autodoc: Async staticmethods/ classmethods are considered as not async
 2021-04-11 02:10:16 +09:00
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