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

18368 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Juan Luis Cano Rodríguez
9aa9d0e2ad
Typo 
Co-authored-by: Takeshi KOMIYA <i.tkomiya@gmail.com>
 2021-09-13 15:03:35 +02:00
Juan Luis Cano Rodríguez
d7e525b9db Insist that automatic is better 2021-09-13 15:00:12 +02:00
Juan Luis Cano Rodríguez
91a605c6f1
Highlight only function docstring 
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
 2021-09-13 14:57:11 +02:00
Juan Luis Cano Rodríguez
5daf336943
Style improvements 
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
 2021-09-13 14:56:31 +02:00
Takeshi KOMIYA
ca146ac18b Close #9623: Allow to suppress warnings on excluded document found in toctree 2021-09-12 19:23:19 +09:00
Takeshi KOMIYA
5c4f741fff Fix i18n: messages in sphinx.directives.other are not translated 2021-09-12 19:23:18 +09:00
Takeshi KOMIYA
fc2ca413ec refactor: Use logger.warning() instead of reporter.warning() 2021-09-12 19:22:55 +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
Juan Luis Cano Rodríguez
53104cadc0 Add reference to tutorial TOC 2021-09-06 17:14:31 +02:00
Juan Luis Cano Rodríguez
2755333437 Add connections to the next sections 2021-09-06 17:14:31 +02:00
Juan Luis Cano Rodríguez
32f2f909ac Simplify installation 2021-09-06 17:14:31 +02:00
Juan Luis Cano Rodríguez
70bc61f0f3 Include explanation about doctests 2021-09-06 16:38:18 +02:00
Juan Luis Cano Rodríguez
878478e725 Simplify doctest section 2021-09-06 16:35:00 +02:00
Juan Luis Cano Rodríguez
d505635224
Be more explicit on automatic xref generation 
Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
 2021-09-06 16:29:43 +02:00
Juan Luis Cano Rodríguez
da93cfc07f Reword primary domains 2021-09-06 16:26:03 +02:00
Juan Luis Cano Rodríguez
722629b35b Rephrase explanation on square brackets 2021-09-06 14:58:18 +02:00
Juan Luis Cano Rodríguez
c721d1746a
Style improvement 
Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
 2021-09-06 14:36:25 +02: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