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

18309 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Jakob Lykke Andersen
c88c718397 Fix typo 2021-10-31 13:15:47 +01:00
Jakob Lykke Andersen
f22faa7e06 Add intersphinx_disabled_domains 
Fixes sphinx-doc/sphinx#2068
Replaces sphinx-doc/sphinx#8981
 2021-10-31 13:15:47 +01:00
Jakob Lykke Andersen
961f5af096 Intersphinx, refactoring 
Also, when a reference is unresolved, don't strip the inventory prefix.
 2021-10-31 13:15:46 +01:00
Takeshi KOMIYA
8dd84bc8ab
Merge pull request #9803 from tk0miya/fix-flake8-error 
Fix flake8 error
 2021-10-31 19:32:29 +09:00
Takeshi KOMIYA
524c99afef Fix a flake8 warning 2021-10-31 16:07:46 +09:00
Takeshi KOMIYA
c497a2867a Update CHANGES for PR #9656 2021-10-31 15:55:51 +09:00
Takeshi KOMIYA
4475dab99e
Merge pull request #9656 from sdhiscocks/suppress_warning_subtype_none 
Fix issue with warnings without subtype being incorrectly suppressed
 2021-10-31 15:51:14 +09:00
Takeshi KOMIYA
cda266333e
Merge pull request #9798 from tk0miya/9775_Literal 
Fix #9775: py domain: Literal typehint was converted to a cross reference
 2021-10-31 15:43:19 +09:00
Takeshi KOMIYA
b2a59ceb8e
Merge pull request #9802 from sphinx-doc/bot/pull-translations 
Update message catalogs
 2021-10-31 15:42:52 +09:00
tk0miya
0f8715e5c9 Update message catalogs 2021-10-31 00:10:50 +00:00
Takeshi KOMIYA
f42d8f7df6
Merge pull request #9801 from tk0miya/docutils-0.18_traverse_2 
Support docutils-0.18: Consume generator of Element.traverse()
 2021-10-31 01:45:37 +09:00
Takeshi KOMIYA
3f3de7d29a Support docutils-0.18: Consume generator of Element.traverse() 
The last fix in i18n module was incorrect because it compares the
"already consumed" generators.  It should compares the lists of nodes.
 2021-10-31 01:33:16 +09:00
Takeshi KOMIYA
65647014e6 Update CHANGES for PR #9772 2021-10-31 01:18:52 +09:00
Takeshi KOMIYA
745e11426f
Merge pull request #9772 from gibsondan/loggingflush 
Closes #9733: Fix for logging handler flushing warnings in the middle of the docs build
 2021-10-31 01:17:59 +09:00
Takeshi KOMIYA
2b5c55e45a
Merge pull request #9797 from tk0miya/9757_inherited_classmethods 
Fix #9757: autodoc_inherit_docstrings does not effect to overriden classmethods
 2021-10-31 00:33:38 +09:00
Takeshi KOMIYA
52787deb32 Fix #9775: py domain: Literal typehint was converted to a cross reference 2021-10-30 16:57:33 +09:00
Takeshi KOMIYA
3c5b31b50d Fix #9757: autodoc_inherit_docstrings does not effect to overriden classmethods 2021-10-30 02:01:38 +09:00
Takeshi KOMIYA
4c91c038b2
Merge pull request #9787 from dmares01/chocolatey-install-link 
Update Chocolatey Install Link
 2021-10-28 01:59:49 +09:00
Drew Mares
5b4b95790a
Update Chocolatey Install Link 
The install URL returned a 404 but now it is updated to the new location
 2021-10-27 11:39:40 -05:00
Takeshi KOMIYA
a16baf1495
Merge pull request #9760 from tk0miya/9756_classmethod_not_having_func 
Fix #9756: autodoc: Crashed if classmethod does not have __func__ attribute
 2021-10-27 02:24:05 +09:00
Takeshi KOMIYA
096108ccac
Merge branch '4.x' into 9756_classmethod_not_having_func 2021-10-27 02:05:36 +09:00
Takeshi KOMIYA
d8b92bb1dc
Merge pull request #9769 from francoisfreitag/fix-linkcheck-auth-link 
Fix linkcheck_auth link to Requests authentication
 2021-10-27 02:04:51 +09:00
Takeshi KOMIYA
5c279a18fc
Merge pull request #9764 from tk0miya/9752_annotated_slots_attribute 
Fix #9752: autodoc: Failed to detect type annotation for slots attribute
 2021-10-27 02:03:30 +09:00
Takeshi KOMIYA
e719b82770
Merge pull request #9780 from tk0miya/docutils-0.18_traverse 
Support docutils-0.18: Consume iterator of Element.traverse()
 2021-10-27 02:02:21 +09:00
Takeshi KOMIYA
13803a79e7 Support docutils-0.18: Consume iterator of Element.traverse() 
Since 0.18, Element.traverse() returns an iterator instead of
intermediate object.  As a result, the return value is always considered
as truthy value.  And it becomes fragile when the caller modifies the
doctree on the loop.
 2021-10-27 01:49:59 +09:00
Takeshi KOMIYA
2be9d6b092
Merge pull request #9774 from sphinx-doc/bot/pull-translations 
Update message catalogs
 2021-10-26 01:54:06 +09:00
tk0miya
498bcad4fb Update message catalogs 2021-10-25 16:48:09 +00:00
Takeshi KOMIYA
20ed920352
Merge pull request #9768 from tk0miya/fix_transifex_client 
Fix CI: Downgrade python for transifex CI
 2021-10-26 01:47:11 +09:00
gibsondan
b1c0d1f00e Closes #9733: Fix for logging handler flushing warnings in the middle of the build 
Summary:
My project was mysteriously dropping warnings (see https://github.com/sphinx-doc/sphinx/issues/9733 for detailed repro) and I realized that it's becaues it imports libraries like airflow or mlflow that set up loggers automatically when they are imported. This causes this handler to flush even though shouldFlush is set to always return False. A simple workaround is to override flush to be a no-op.

Test Plan: Repeat repro steps from #9733 - project now always includes warnings
 2021-10-25 10:17:01 -05:00
François Freitag
70e0c314ca Fix linkcheck_auth link to Requests authentication 
The link was directing to
https://www.sphinx-doc.org/en/master/usage/requests-auth>. Prefer using
the intersphinx module to generate the link, it’s more robust than
directly linking to the page.
 2021-10-25 15:04:15 +02:00
Takeshi KOMIYA
c39cf2e750 Fix CI: Downgrade python for transifex CI 2021-10-25 11:00:01 +09:00
Takeshi KOMIYA
f57178739e
Merge pull request #9767 from tk0miya/fix_transifex_client 
Fix CI: Downgrade python for transifex CI
 2021-10-25 09:41:37 +09:00
Takeshi KOMIYA
71c1fb01b9 Fix CI: Downgrade python for transifex CI 
The latest transifex-client could not be installed on python 3.10
environment.  This downgrade python to 3.9 to be install the latest one.

ref: https://github.com/transifex/transifex-client/pull/330
 2021-10-25 09:31:43 +09:00
Takeshi KOMIYA
15807d7de0
Merge pull request #9765 from mitya57/typo 
Fix a typo in variable name
 2021-10-24 03:13:56 +09:00
Dmitry Shachnev
66ec92b2a2 Fix a typo in variable name 2021-10-23 14:33:00 +03:00
Takeshi KOMIYA
3ad591a631 Update CHANGES for PR #9737 2021-10-23 17:07:39 +09:00
Takeshi KOMIYA
b097213098
Merge pull request #9737 from ahippo/latex-aggedright 
LaTeX: fix '\raggedright' escaping causing "aggedright" text
 2021-10-23 17:06:03 +09:00
Takeshi KOMIYA
b60c43e1d0 Update CHANGES for PR #9685 2021-10-23 16:41:20 +09:00
Takeshi KOMIYA
aea2af418e
Merge pull request #9685 from MatthijsBurgh/patch-1 
Set refdoc to be used by missing-reference, intersphinx
 2021-10-23 16:22:50 +09:00
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
ced8895b12 Fix #9756: autodoc: Crashed if classmethod does not have __func__ attribute 2021-10-23 02:14:57 +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