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

18266 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
b778ee806e Fix #9752: autodoc: Failed to detect type annotation for slots attribute 2021-10-23 14:59:36 +09:00
Takeshi KOMIYA
e6f9603494 Update CHANGES for PR #9763 2021-10-23 13:03:12 +09:00
Takeshi KOMIYA
5daa320d4a
Merge pull request #9763 from QuLogic/fix-parameter-breaks 
Fix selection of parameter names in HTML theme
 2021-10-23 12:43:18 +09:00
Elliott Sales de Andrade
ac6935bc44 Fix selection of parameter names in HTML theme 
Parameters are written in HTML as (leaving out some internal classes):
```
<strong>name</strong><span class="classifier"><a><code><span>TypeName</span></code></a></span>
```
but in rendered form there's a colon between the name and type. This
colon is inserted virtually using CSS, but since it doesn't exist, the
browser thinks both sides are part of the same word.

Styling the virtual text as inline block makes it be treated as a break,
but also makes it apply vertical margins, so we need to set those to
zero again.

See https://github.com/matplotlib/matplotlib/issues/21432
 2021-10-22 17:48:21 -04:00
Takeshi KOMIYA
cf96c93cf1
Merge pull request #9724 from tk0miya/support_PreBibliographic_nodes 
Support docutils-0.18: allow PreBibliographic nodes before docinfo
 2021-10-23 02:33:00 +09:00
Takeshi KOMIYA
8118f979dc Support docutils-0.18: allow PreBibliographic nodes before docinfo 
Since 0.18, `meta` directive inserts meta node into the top of the
document.  It confuses MetadataCollector.

This allows doctree contains PreBibliographic nodes just before docinfo
node.
 2021-10-23 02:20:46 +09:00
Takeshi KOMIYA
cc85aef61e
Merge pull request #9725 from tk0miya/set_auto_id_prefix_explicitly 
Support docutils-0.18: Set auto_id_prefix explicitly
 2021-10-23 02:19:41 +09:00
Takeshi KOMIYA
3045e81d6e Update CHANGES for PR #9755 2021-10-23 02:19:03 +09:00
Chris Lamb
ff533f59bb Make util.typing.restify sanitise unreproducible output (eg. memory addresses) 
Whilst working on the Reproducible Builds effort [0] I noticed that sphinx
generates output that is not reproducible, causing a number of packages in
Debian to unreproducible.

Specifically, when Sphinx locates an alias of an instance when generating
'autodoc' documentation, it uses the raw Python repr(...) of the object and
does not sanitise it for memory addresses (etc.) like elsewhere in Sphinx.

This can result in documentation like this:

-<dd><p>alias of &lt;webob.client.SendRequest object at 0x7fd769189df0&gt;</p>
+<dd><p>alias of &lt;webob.client.SendRequest object at 0x7f0f02233df0&gt;</p>

Patch attached that uses the object_description method, which was added to fix
precisely this kind of issue.

I originally filed this in Debian as bug #996948 [1].

 [0] https://reproducible-builds.org/
 [1] https://bugs.debian.org/996948
 2021-10-23 02:18:01 +09:00
Takeshi KOMIYA
6472fb9224
Merge pull request #9745 from sphinx-doc/bot/pull-translations 
Update message catalogs
 2021-10-21 01:29:30 +09:00
Takeshi KOMIYA
afb44f15f8
Merge pull request #9753 from Marsfan/patch-1 
Add missing space in intersphinx doc
 2021-10-21 01:28:57 +09:00
Gabe R
1bc98b7860
Add missing space in intersphinx doc 
There was a space missing between `-m` and `sphinx.ext.intersphinx` in the example of showing all mappings in a intersphinx file. I added it in.
 2021-10-19 11:33:23 -07:00
tk0miya
05ed77475f Update message catalogs 2021-10-17 00:10:43 +00:00
Takeshi KOMIYA
f9a33d2b3a Support docutils-0.18: Set auto_id_prefix explicitly 
Since docutils-0.18, auto_id_prefix setting will be changed to `'%'`
from `'id'`.  To keep backward compatibility of node IDs, this sets
`'id'` to settings explicitly.
 2021-10-11 01:52:05 +09:00
Takeshi KOMIYA
56f97d71a2
Merge pull request #9719 from tk0miya/9718_intersphinx 
Fix #9718: intersphinx: Failed to invoke sphinx.ext.intersphinx module
 2021-10-10 19:46:07 +09:00
Takeshi KOMIYA
1b8d40b201
Merge pull request #9717 from tk0miya/9710_even_odd_rows 
Fix #9710: html: Wrong styles for even/odd rows in nested tables
 2021-10-10 19:45:45 +09:00
Takeshi KOMIYA
c6131066c8
Merge pull request #9722 from sphinx-doc/bot/pull-translations 
Update message catalogs
 2021-10-10 19:16:08 +09:00
tk0miya
d6be195e43 Update message catalogs 2021-10-10 09:52:50 +00:00
Takeshi KOMIYA
3b8456f74c
Merge pull request #9721 from tk0miya/docutils-0.18-traverse 
refactor: Node.traverse() will returns generator since 0.18
 2021-10-10 16:36:40 +09:00
Takeshi KOMIYA
179e0bf8a2 refactor: Node.traverse() will returns generator since 0.18 2021-10-10 15:50:39 +09:00
Takeshi KOMIYA
2adc41cb86 Fix #9718: intersphinx: Failed to invoke sphinx.ext.intersphinx module 
A circular import was happened since #9701 merged.  This goes
lazy-import to avoid the error.
 2021-10-09 19:06:27 +09:00
Takeshi KOMIYA
dd2ff3e911 Fix #9710: html: Wrong styles for even/odd rows in nested tables 2021-10-09 16:35:31 +09:00
Takeshi KOMIYA
3aabcd2f80 Update CHANGES for PR #9688 2021-10-09 16:29:19 +09:00
Takeshi KOMIYA
be36cf471b
Merge pull request #9679 from latosha-maltba/doc/directive-indent 
Document indent behaviour for directives
 2021-10-09 16:26:52 +09:00
Takeshi KOMIYA
15df18392a
Merge pull request #9688 from latosha-maltba/class-option-for-code-directive 
Fix bug of Sphinx's .. code:: directive not recognizing :class: option
 2021-10-09 16:26:29 +09:00
Takeshi KOMIYA
d412acd291
Merge branch '4.x' into class-option-for-code-directive 2021-10-09 16:10:04 +09:00
Takeshi KOMIYA
c09f28e74f
Merge pull request #9711 from tk0miya/9708_needs_extension_logic 
Fix #9708: needs_extension failed to check double-digit version correctly
 2021-10-09 15:34:03 +09:00
Takeshi KOMIYA
bbccb49680 Fix #9688: ImportError for set_classes() 2021-10-09 15:27:44 +09:00
Takeshi KOMIYA
23bb8bee85
Merge branch '4.x' into class-option-for-code-directive 2021-10-09 15:18:17 +09:00
Takeshi KOMIYA
2e36027474
Merge branch '4.x' into 9708_needs_extension_logic 2021-10-09 15:17:23 +09:00
Takeshi KOMIYA
81a4fd973d
Merge pull request #9699 from tk0miya/9683_add_css_file 
Close #9683: Revert the removal of ``add_stylesheet()`` API
 2021-10-09 15:12:43 +09:00
Takeshi KOMIYA
7da94ee7bb
Merge pull request #9698 from tk0miya/9697_property_with_parens 
Fix #9697: An index entry with parens was registered for py:method
 2021-10-09 15:12:31 +09:00
Takeshi KOMIYA
3c9e53852d Fix #9708: needs_extension failed to check double-digit version correctly 2021-10-09 14:59:05 +09:00
Takeshi KOMIYA
99b8019e64 Merge branch '4.x' into 9683_add_css_file 2021-10-09 14:50:15 +09:00
Takeshi KOMIYA
2a7775dbb8 Merge branch '4.x' into 9697_property_with_parens 2021-10-09 14:49:57 +09:00
Takeshi KOMIYA
f050a7775d
Merge pull request #9715 from tk0miya/test_with_py311-dev 
CI: Install the latest py package on testing with py3.11-dev
 2021-10-09 14:48:31 +09:00
Takeshi KOMIYA
2760b3bb79 test: Support python-3.11 2021-10-09 14:41:39 +09:00
Takeshi KOMIYA
30d5aeef58 CI: Install the latest py package on testing with py3.11-dev 2021-10-09 14:30:37 +09:00
Takeshi KOMIYA
34f957f131
Merge branch '4.x' into 9697_property_with_parens 2021-10-09 14:00:39 +09:00
Takeshi KOMIYA
0424da31ab
Merge branch '4.x' into 9683_add_css_file 2021-10-09 13:58:10 +09:00
Takeshi KOMIYA
0f0b93df9e
Merge pull request #9702 from tk0miya/test_with_docutils-latest 
test: Do test with the HEAD of docutils
 2021-10-09 13:57:37 +09:00
Takeshi KOMIYA
7f6d8e97cb
Merge pull request #9701 from tk0miya/docutils-0.18 
Follow new structure of docutils-0.18
 2021-10-09 13:55:32 +09:00
Takeshi KOMIYA
7dc4a75019
Merge pull request #9712 from sphinx-doc/support_py310 
Support Python 3.10
 2021-10-09 13:54:08 +09:00
Takeshi KOMIYA
481c5e9c4b
Merge pull request #9534 from astrojuanlu/new-tutorial-describing-code 
New Sphinx tutorial, part III
 2021-10-09 13:05:48 +09:00
Takeshi KOMIYA
5a79bafe85 CI: Install unreleased "py" package for 3.11-dev 2021-10-09 13:00:48 +09:00
Takeshi KOMIYA
f13ad80207 Support Python 3.10 2021-10-07 02:34:44 +09:00
Jakob Lykke Andersen
c922189920
Merge pull request #9695 from jakobandersen/js_nodes 
JS, use more desc_sig_* nodes
 2021-10-05 19:11:01 +02:00
Latosha Maltba
9c53175528 Fix bug of Sphinx's .. code:: directive not recognizing :class: option 
Sphinx's own .. code:: directive (but not docutils') does not recognise
the :class: option but only the :classes: option.  This is probably due
to an oversight that the user-visible option is called ``:class:`` while
the Python attribute is called ``classes`` (to not collide with the
keyword ``class``).

Fix it by checking for the option ``class`` instead of ``classes``.
 2021-10-03 21:18:17 +00:00
Takeshi KOMIYA
37730d0f8e
Merge pull request #9703 from rffontenelle/patch-1 
doc: fix grammar of possessive of plural noun
 2021-10-04 00:13:27 +09:00
Rafael Fontenelle
ca74c94610
doc: fix grammar of possessive of plural noun 2021-10-03 11:04:10 -03:00