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,373 Commits 2 Branches 219 Tags 163 MiB
4b383febf4
Commit Graph

18373 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
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
Juan Luis Cano Rodríguez
4920e4e5dc Explain that there are several domains 2021-09-13 15:48:47 +02:00
Juan Luis Cano Rodríguez
ae3eab278c Get function signature right since the beginning 2021-09-13 15:33:37 +02:00
Juan Luis Cano Rodríguez
02119aba8d Fix line width 2021-09-13 15:29:25 +02:00
Juan Luis Cano Rodríguez
9a8d7aef2f Use stable Sphinx version 2021-09-13 15:28:17 +02:00
Juan Luis Cano Rodríguez
ccc95ea626 Amend explanation on the default-domain directive 2021-09-13 15:24:36 +02:00
Juan Luis Cano Rodríguez
1677f416bc Point readers to info field lists instead 2021-09-13 15:23:19 +02:00
Juan Luis Cano Rodríguez
87b8a0b211 Remove square brackets 2021-09-13 15:17:14 +02:00
Juan Luis Cano Rodríguez
c2847c2563 Improve text of some links 2021-09-13 15:13:01 +02:00
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
3d8fbd992c Merge branch '4.x' 2021-09-12 16:56:34 +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
b8b8041429
Merge pull request #9613 from tk0miya/RemovedInSphinx50Warning_linkcheck 
refactor: linkcheck: Remove objects marked as RemovedInSphinx50Warning
 2021-09-11 17:19:05 +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
2c21e91b5f Merge branch '4.x' 2021-09-11 17:13:21 +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
514fca7a40 Merge branch '4.x' 2021-09-06 02:16:04 +09:00