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,112 Commits 2 Branches 219 Tags 163 MiB
699d03f597
Commit Graph

18112 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
699d03f597 Update CHANGES for PR #9670 2021-09-25 14:39:50 +09:00
Takeshi KOMIYA
d75e3171cd
Merge pull request #9670 from jonppe/fix-download-file-with-special-characters 
Fix download file with special characters
 2021-09-25 14:38:48 +09:00
Johannes Aalto
b2bd115dc8 Fix local file download by encoding URL 
Properly encode links to files with special characters for the user to
actually be able to download them.

The issue still remains for image files but the logic path
is quite different than with other files fix might involve changes
to docutils.

Fixes sphinx-doc/sphinx#3097

Signed-off-by: Johannes Aalto <ext-johannes.aalto@vaisala.com>
 2021-09-24 20:34:09 +03:00
Johannes Aalto
fa3b334ed0 Add test for encoding local file links with special characters 
Add test to make sure Sphinx uses proper URL encoding for
special characters in file names.

Use test_html_download() since it test_html5_output() doesn't
quite seem to have easy pattern to verify the contents of href
attribute.

Issue #3097

Signed-off-by: Johannes Aalto <ext-johannes.aalto@vaisala.com>
 2021-09-24 20:34:09 +03:00
Takeshi KOMIYA
274ee481ac
Merge pull request #9647 from tk0miya/9637_Builder.allow_parallel 
Fix #9637: Add Builder.allow_parallel to the list of builder APIs
 2021-09-20 17:02:49 +09:00
Takeshi KOMIYA
a05dc0b419
Merge pull request #9650 from sphinx-doc/bot/pull-translations 
Update message catalogs
 2021-09-19 11:38:44 +09:00
tk0miya
9f329fb3c9 Update message catalogs 2021-09-19 00:10:12 +00:00
Takeshi KOMIYA
29ac4c1982 Fix #9637: Add Builder.allow_parallel to the list of builder APIs 2021-09-18 01:26:12 +09:00
Takeshi KOMIYA
3774c124f8 Update CHANGES for PR #9644 2021-09-18 01:21:13 +09:00
Takeshi KOMIYA
62fd91b8d1
Merge pull request #9644 from xmo-odoo/fix-sourcename-broken-getattr 
Protect `sphinx.ext.autodoc.get_sourcename` against misbehaving `__getattr__`
 2021-09-18 01:18:57 +09:00
Takeshi KOMIYA
506590d4ba
Merge pull request #9640 from tk0miya/9639_support_asyncgenfunction 
Close #9639: autodoc: Support asynchronous generator functions
 2021-09-18 01:03:34 +09:00
Takeshi KOMIYA
bebd6bdab1
Merge pull request #9633 from tk0miya/9630_autosummary_primary_domain 
Fix #9630: autosummary: Failed to build summary table if primary_domain is not 'py'
 2021-09-18 01:02:55 +09:00
Xavier Morel
69af4d2d00 Protect get_sourcename against misbehaving __getattr__ 2021-09-17 08:44:10 +02:00
Takeshi KOMIYA
ccfca458ea Close #9639: autodoc: Support asynchronous generator functions 2021-09-17 02:20:40 +09:00
Takeshi KOMIYA
bc012076b8 Fix #9630: autosummary: Failed to build summary table if primary_domain is not 'py' 
Autosummary generates reST code that uses raw `:obj:` xrefs to refer
the python objects in the summary table.  But they're fragile because
they assume the primary_domain=='py'.

This adds `:py:` prefix to these xrefs to make them robust.
 2021-09-14 23:59:47 +09:00
Takeshi KOMIYA
ed227d7d3c Fix #9630: autodoc: Failed to build xrefs if primary_domain is not 'py' 
Autodoc generates reST code that uses raw `:obj:` and `:class:` xrefs to
refer the classes and types.  But they're fragile because they assume
the primary_domain=='py'.

This adds `:py:` prefix to these xrefs to make them robust.
 2021-09-14 23:59:47 +09:00
Takeshi KOMIYA
ba2439a105 Bump version 2021-09-12 16:55:46 +09:00
Takeshi KOMIYA
cf38356a08 Bump version 2021-09-12 16:54:59 +09:00
Takeshi KOMIYA
21db4b1407 Bump to 4.2.0 final 2021-09-12 16:51:24 +09:00
Takeshi KOMIYA
2390ce6e1a CHANGES: Merge 4.1.3 (unreleased) to 4.2.0 2021-09-12 16:48:25 +09:00
Takeshi KOMIYA
b67624ec76
Merge pull request #9627 from sphinx-doc/bot/pull-translations 
Update message catalogs
 2021-09-12 16:33:22 +09:00
tk0miya
50d7bfa6b8 Update message catalogs 2021-09-12 00:10:39 +00:00
Takeshi KOMIYA
260f217a3d
Merge pull request #9594 from hkuno/pr/no_empty_desc_4.x 
let user skip printing command description
 2021-09-11 19:08:37 +09:00
Takeshi KOMIYA
fb141c355f Update CHANGES for PR #9594 2021-09-11 18:54:29 +09:00
Takeshi KOMIYA
571929974a Add a testcase for #9694 2021-09-11 18:47:24 +09:00
Takeshi KOMIYA
c44ee0ebaa
Merge pull request #9611 from tk0miya/9560_NewType_module 
Close #9560: autodoc: Allow to refer NewType with modname in py310+
 2021-09-11 17:19:54 +09:00
Takeshi KOMIYA
8416813168
Merge pull request #9616 from jdufresne/fix-url 
Update Sphinx url: s|https?://sphinx-doc\.org/|https://www.sphinx-doc.org/|g
 2021-09-11 17:16:47 +09:00
Takeshi KOMIYA
3a67b49f5d Update CHANGES for PR #9617 2021-09-11 17:12:59 +09:00
James Knight
e01d914dbd themes: use noscript for search js notification 
The "search.html" template will generate a warning admonition about
requiring JavaScript for search and automatically hiding the element
when supported. While functional, if a client renders the page slowly,
the warning notification may be visible to the user for a moment.

Instead of relying on JavaScript to suppress this warning, use a
`noscript` tag to hide the warning for clients who do not support
JavaScript. This also has the benefit of one less JavaScript call
required by a client.

Signed-off-by: James Knight <james.d.knight@live.com>
 2021-09-11 17:04:57 +09:00
Takeshi KOMIYA
293beecc06
Merge pull request #9619 from cclauss/patch-1 
setup.py: Fix broken url on the Sphinx PyPI page
 2021-09-11 16:55:50 +09:00
Takeshi KOMIYA
4442f32e7a
Merge pull request #9621 from cclauss/codespell-again 
Fix typos discovered by codespell (again)
 2021-09-11 16:54:45 +09:00
Christian Clauss
d2c95dfd0c overridden 2021-09-08 02:33:10 +02:00
Christian Clauss
86583c578c Fix typos discovered by codespell 2021-09-08 02:15:25 +02:00
Christian Clauss
95f47d8b2e
setup.py: Fix broken url on the PyPI page 2021-09-07 19:36:07 +02:00
Jon Dufresne
7dd112b110 Update Sphinx url: s|https?://sphinx-doc\.org/|https://www.sphinx-doc.org/|g 
https://sphinx-doc.org is unreachable, but is linked from the PyPI page:
https://pypi.org/project/Sphinx/. Switch to https://www.sphinx-doc.org/
instead.
 2021-09-06 13:15:48 -07:00
Harumi Kuno
d0e014b4bc Omit NAME section if blank description 
Also, update man page for configuration to document that
if a blank description is entered, the "NAME" section is an
empty string.

Signed-off-by: Harumi Kuno <harumi.kuno@hpe.com>
 2021-09-05 17:42:03 -07:00
Takeshi KOMIYA
c5b35efce3 Close #9560: autodoc: Allow to refer NewType with modname in py310+ 
Before 3.10, an instance of NewType has incorrect module name. But it
was fixed on 3.10.  This starts to use the module info if the
interpreter is 3.10+.
 2021-09-05 18:28:27 +09:00
Takeshi KOMIYA
336605b8e4
Merge pull request #9610 from sphinx-doc/bot/pull-translations 
Update message catalogs
 2021-09-05 17:02:26 +09:00
Takeshi KOMIYA
bd5e40ce3a
Merge pull request #9609 from tk0miya/9608_apidoc_pymod_definition_for_implicit_namespace 
Fix #9608: apidoc: module is not described if implicit namespace package
 2021-09-05 16:34:58 +09:00
Takeshi KOMIYA
a3f08fe298
Merge pull request #9606 from tk0miya/9600_typehints_including_commas 
Fix #9600: autosummary: Typehints including commas confuses autosummary
 2021-09-05 16:34:01 +09:00
Takeshi KOMIYA
4ad45cec52
Merge pull request #9602 from tk0miya/9576_Literal_xref 
Fix #9576: py domain: Literal typehint was converted to a cross reference
 2021-09-05 16:33:02 +09:00
tk0miya
c2e9970acc Update message catalogs 2021-09-05 07:26:40 +00:00
Takeshi KOMIYA
223d615011 Fix #9608: apidoc: module is not described if implicit namespace package 
To make implicit namespace packages referencable, this outputs empty
module definitions for them.
 2021-09-04 22:44:04 +09:00
Takeshi KOMIYA
0a8655b733 Fix #9600: autosummary: Typehints including commas confuses autosummary 2021-09-04 01:54:11 +09:00
Takeshi KOMIYA
34664ce4ce Fix #9576: py domain: Literal typehint was converted to a cross reference 
The content of Literal typehint should not be converted to cross
references.
 2021-09-03 22:09:30 +09:00
Takeshi KOMIYA
6c38f68dae
Merge pull request #9582 from blueyed/tox-passenv-COLORTERM 
ci(tox.ini): add COLORTERM to passenv
 2021-09-02 02:27:55 +09:00
Takeshi KOMIYA
80fbbb8462
Merge pull request #9591 from tk0miya/9585_type_for_pyproperty 
Fix #9585: py:property directive does not create a hyperlink for types
 2021-09-01 00:16:24 +09:00
Takeshi KOMIYA
3e24190564 Fix #9585: py:property directive does not create a hyperlink for types 2021-08-31 23:55:12 +09:00
Harumi Kuno
26be2d1a77 skip empty description 
Don't print the description of a command as a subtitle
when generating a manpage if the description is empty.
This commit addresses sphinx-doc#9430

Signed-off-by: Harumi Kuno <harumi.kuno@hpe.com>
 2021-08-30 08:33:19 -07:00
Daniel Hahler
e89de152d8 ci(tox.ini): add COLORTERM to passenv 
This is required for [kitty](https://sw.kovidgoyal.net/kitty/), which
uses TERM=xterm-kitty, which is not detected as being a colored
terminal, without its `COLORTERM=truecolor` also being passed [1].

1: d194e0f490/sphinx/util/console.py (L70-L71)
 2021-08-30 10:32:30 +02:00