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,736 Commits 2 Branches 219 Tags 163 MiB
8224f6f44a
Commit Graph

3402 Commits

Author SHA1 Message Date
Juan Luis Cano Rodríguez
eceb6b8f4b
Remove reference to unmaintained extension 2021-11-15 14:30:07 +01:00
Juan Luis Cano Rodríguez
d7d82a88ad
Typo 
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
 2021-11-15 14:29:17 +01:00
Juan Luis Cano Rodríguez
34c165e497 Add clarification on other languages 2021-11-15 12:46:03 +01:00
Josh Mitchell
79089b5fa4 Corrections from review by tk0miya 2021-11-15 13:18:47 +11:00
Josh Mitchell
ad0071ddb7 #2021: Allow autosummary to respect __all__ 2021-11-15 13:16:33 +11:00
Martin Liska
9ec829fb50 texinfo: simplify reference emission. 
The commit adds a new config value 'texinfo_emit_document_references'
that blocks the emission of inline references and make it better readable
with legacy stand-alone reader ``info``.

Before the change we emit:
Default option value for @ref{e,,-Wshift-overflow3}.

while with texinfo_emit_document_references == True:
Default option value for -Wshift-overflow3.

It addresses limitations mentioned in Sphinx' FAQ:
https://www.sphinx-doc.org/en/master/faq.html#texinfo-info
 2021-11-12 14:00:48 +01:00
oleg.hoefling
629145a0e8
replace hardcoded refs in docs with extlinks 
Signed-off-by: oleg.hoefling <oleg.hoefling@gmail.com>
 2021-11-12 09:41:34 +01: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
Latosha Maltba
54b1991e74 Update :dedent: example 
The presence or absence of the ``:dedent: 4`` option in the example

.. code-block:: ruby
   :dedent: 4

       some ruby code

makes no difference for the output due to how ReST handles whitespace.
If it is present, then ReST indent is 3 and the 4 spaces of the code are
stripped by the :dedent: option.  If the dedent option is missing, then
the ReST indent is 7 and all whitespace is stripped again.

Add a dummy option to fixate the ReST indent to 3, so adding and
removing of the option in the example has an effect on the output.
 2021-09-23 07:52:39 +00: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
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
Christian Clauss
86583c578c Fix typos discovered by codespell 2021-09-08 02:15:25 +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
12cf4ebc1f
Merge pull request #9545 from aaugustin/4.x 
Update link to OpenSearch.
 2021-08-14 22:37:34 +09:00
Aymeric Augustin
56add529ec
Update link to OpenSearch. 
Amazon repurposed the opensearch.org domain.

It is now hosting their ElasticSearch fork.
 2021-08-14 11:49:34 +02:00
Kevin Anderson
cfd5536b27 fix typo in numfig_format default value 2021-08-13 07:20:16 -06:00
Juan Luis Cano Rodríguez
a606db01f1 Add section on autosummary 2021-08-12 20:09:50 +02:00
Juan Luis Cano Rodríguez
8573c281ec Add section on automatic documentation generation 2021-08-12 20:09:50 +02:00
Juan Luis Cano Rodríguez
8334fd983e Add section on doctests 2021-08-12 20:09:50 +02:00
Juan Luis Cano Rodríguez
a5c684510e Add section on Python code preparation 2021-08-12 20:06:56 +02:00
Juan Luis Cano Rodríguez
2c1fa831c1 Add tutorial section on documenting Python objects 2021-08-12 20:06:56 +02:00
Juan Luis Cano Rodríguez
1a1e45f1af Add cross reference to role definitions 2021-08-12 20:06:56 +02:00
Juan Luis Cano Rodríguez
f152680bfb Split tutorial in several files 2021-08-11 13:31:47 +02:00
Takeshi KOMIYA
8948f45226
Merge pull request #9527 from tk0miya/9525_tutorial 
Fix #9525: tutorial: Wrong condition in recipe.py
 2021-08-11 02:14:12 +09:00
John Cole
8dbef8798a Fix typo 2021-08-04 20:28:45 -04:00
Takeshi KOMIYA
c1692faba7 Fix #9525: tutorial: Wrong condition in recipe.py 2021-08-05 01:38:58 +09:00
Takeshi KOMIYA
641174db5d
Merge pull request #9447 from Blendify/Blendify/html-templates-sphinx-version 
HTML Templates: Expose full sphinx version tuple
 2021-08-02 02:08:50 +09:00
Takeshi KOMIYA
6e87c17a76 doc: Add document for autoproperty directive (refs: #9486) 2021-07-23 23:10:48 +09:00
Takeshi KOMIYA
362f36d35d
Merge pull request #9461 from tk0miya/9445_class_property 
Close #9445: Support class properties
 2021-07-20 01:12:04 +09:00
Takeshi KOMIYA
445c340cbd
Merge pull request #9474 from jfbu/latex_document_9166 
LaTeX: add some documentation for container support (#9166)
 2021-07-20 01:00:28 +09:00
Takeshi KOMIYA
0e5dab0dc1 Merge branch '4.1.x' into 4.x 2021-07-20 00:59:03 +09:00
jfbu
e1612b4909 Remove mark-up breaking PDF output 
Close: #9475

Refs: #9355
 2021-07-19 12:23:30 +02:00
jfbu
af5363cefb LaTeX: add some documentation for container support (#9166) 2021-07-19 12:10:15 +02:00
usaturn
c56a37e4d5 fix link of code of conduct 2021-07-17 17:38:27 +09:00
Takeshi KOMIYA
120525563c Cloase #9445: :py:property: directive now supports :classmethod: option 
Since python 3.9, `classmethod` starts to support creating a "class
property".  This allows to describe it.
 2021-07-17 14:24:31 +09:00
Aaron Carlisle
426fdcabcd HTML Templates: Expose full sphinx version tuple 
Previously, there was only a string which is problematic
when you want to programmatically compare versions
for compatibility reasons.
 2021-07-13 20:44:46 -04:00
Takeshi KOMIYA
7e3e15231e
Merge pull request #9419 from zhsj/fancyvrb-zh 
Add xeCJKVerbAddon to default fvset config for Chinese documents
 2021-07-11 01:43:44 +09:00
Shengjing Zhu
92c9cabae5 Add xeCJKVerbAddon to default fvset config for Chinese documents 
Prevent xeCJK from adding extra spaces in fancyvrb Verbatim enviroment.

Fixes: #9414

Signed-off-by: Shengjing Zhu <i@zhsj.me>
 2021-07-09 01:53:52 +08:00
Eisuke Kawashima
652ebf1bf5
Fix typo 2021-07-08 08:16:22 +09:00
Takeshi KOMIYA
5e5bca98f7
Merge branch '4.x' into 6525_linkcheck_warn_redirects 2021-07-07 02:09:50 +09:00
Takeshi KOMIYA
5ce5f40402
Merge pull request #9340 from ocket8888/patch-1 
Update example to use recommended usage
 2021-07-07 01:50:34 +09:00
Juan Luis Cano Rodríguez
b9da1577b6 Merge branch '4.x' into new-tutorial-part-ii 2021-07-05 20:12:53 +02:00
Juan Luis Cano Rodríguez
cb846a39e0 Add link to docutils docs 2021-07-05 09:39:14 +02:00
Juan Luis Cano Rodríguez
6f9bc6e7e5 Use "builtin" for extensions label as it is done for themes 2021-07-05 09:32:10 +02:00