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,369 Commits 2 Branches 219 Tags
ad36d86d2ccafd5a29cbcd9734fcdb31cc8d6595
Commit Graph

3345 Commits

Author SHA1 Message Date
Juan Luis Cano Rodríguez
ad36d86d2c Add descriptive section to deployment section of tutorial 2021-11-17 21:36:48 +01:00
Matt Ficke
2ed4bed33a Update RFC base url 
The tools.ietf.org subdomain is being wound down and services are moving to
datatracker.ietf.org. Links to RFC documents using the old subdomain are being
redirected to datatracker; this updates the configured `rfc_base_url` to
point to the current subdomain.

Discussion: https://mailarchive.ietf.org/arch/msg/ietf/0n-6EXEmkTp3Uv_vj-5Vnm3o0bo/
 2021-11-16 10:52:02 -05:00
Takeshi KOMIYA
096e28693e Merge pull request #9628 from tk0miya/9623_suppress_warnings_for_excluded_document_in_toctree 
Close #9623: Allow to suppress warnings on excluded document found in toctree
 2021-11-10 02:17:04 +09:00
Takeshi KOMIYA
7357b17e09 Merge branch '4.x' into 9623_suppress_warnings_for_excluded_document_in_toctree 2021-11-10 01:44:28 +09:00
Takeshi KOMIYA
22bec4ffe4 Fix #9623: Separate warning type 'toc.not_readable' to 'toc.excluded' 2021-11-10 01:43:59 +09:00
Takeshi KOMIYA
203094b4c3 Close #9618: i18n: Add gettext_allow_fuzzy_translations 2021-11-10 01:32:02 +09:00
Martin Fischer
43be17acf1 Document responsiveness of themes 2021-11-03 10:53:38 +01:00
Jakob Lykke Andersen
56002be5e1 rename intersphinx_disabled_{refs -> reftypes} 
And change format for domains to {name}:*
 2021-10-31 13:56:26 +01:00
Jakob Lykke Andersen
484d74ad97 intersphinx_disabled_refs, doc default value 2021-10-31 13:42:26 +01:00
Jakob Lykke Andersen
cfbac2ceaa intersphinx_disabled_refs, rename 'all' to '*' 2021-10-31 13:23:23 +01:00
Jakob Lykke Andersen
0d9f4cd469 Generalize to disable specific refs as well. 2021-10-31 13:15:47 +01:00
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
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
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
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
b778ee806e Fix #9752: autodoc: Failed to detect type annotation for slots attribute 2021-10-23 14:59:36 +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
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
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
0424da31ab Merge branch '4.x' into 9683_add_css_file 2021-10-09 13:58:10 +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
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
Rafael Fontenelle
ca74c94610 doc: fix grammar of possessive of plural noun 2021-10-03 11:04:10 -03:00
Jakob Lykke Andersen
1fe87938e2 js nodes, docs, add entry in deprecation/removal table 2021-10-03 10:18:51 +02:00
Takeshi KOMIYA
1fbca49970 Close #9683: Revert the removal of `add_stylesheet()` API 
It will be kept until the Sphinx-6.0 release.

Note: Now it emits a warning instead of DeprecationWarning to let the
users know the deprecation.
 2021-10-03 16:34:57 +09:00
Jakob Lykke Andersen
a6246c1b65 Typo fixes 2021-10-01 20:48:12 +02:00
Jakob Lykke Andersen
91d0289009 C++, add retval info field to cpp:function 2021-10-01 20:47:14 +02:00
Jakob Lykke Andersen
57fad5c044 C, update documentation for info-fields 2021-10-01 18:38:30 +02:00
Ghassan Maslamani
d20646194c doc: update description 
Update description about how `conf.py` is loaded/executed
 2021-09-30 13:43:09 +03:00
Latosha Maltba
ee3f361992 Document indent behaviour for directives 
Mention how the indent of the contents for directives is chosen and what
the effect on directives which are sensitive to whitespace is,
e.g. code-block.
 2021-09-27 09:06:52 +00:00
Takeshi KOMIYA
c0333d4464 Merge pull request #9666 from tk0miya/9662_docs_for_ObjectDescription 
Add doc for ObjectDescription (refs: #9662)
 2021-09-27 01:57:36 +09:00
Takeshi KOMIYA
de59a72fe6 Merge pull request #9665 from tk0miya/9664_autodoc_process_bases_injection 
Close #9664: autodoc: autodoc-process-bases supports reST snippet
 2021-09-26 00:54:42 +09:00
Takeshi KOMIYA
9543962da6 Add doc for ObjectDescription (refs: #9662) 2021-09-23 12:56:09 +09:00
Takeshi KOMIYA
d13b86e02f Close #9664: autodoc: autodoc-process-bases supports reST snippet 
This allows to inject a reST snippet through autodoc-process-bases
event.  It helps to modify the base classes of any class to the expected
mark-up'ed text by custom extension.
 2021-09-23 10:59:01 +09:00
Takeshi KOMIYA
29ac4c1982 Fix #9637: Add Builder.allow_parallel to the list of builder APIs 2021-09-18 01:26:12 +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
ca146ac18b Close #9623: Allow to suppress warnings on excluded document found in toctree 2021-09-12 19:23:19 +09: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