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
20,417 Commits 2 Branches 219 Tags
de6d3665ef85b778756af3ed7fd714378ec73911
Commit Graph

847 Commits

Author SHA1 Message Date
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
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
Takeshi KOMIYA
0f6afa5992 Merge branch '4.x' 2021-11-11 02:25:42 +09: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
Takeshi KOMIYA
7a6272f93f Merge branch '4.x' 2021-11-07 19:55:06 +09:00
Takeshi KOMIYA
9ae86a19cd Merge pull request #9806 from jenshaase/patch-1 
Fixed docker links in the installation.rst
 2021-11-07 19:17:25 +09:00
Martin Fischer
43be17acf1 Document responsiveness of themes 2021-11-03 10:53:38 +01:00
Jens Haase
dca21ceab4 Fixed docker links in the installation.rst 
The old links, linked to a login page of docker hub. The new links link to the public pages.
 2021-11-01 13:31:47 +01:00
Jakob Lykke Andersen
68abc2a122 Change default value of intersphinx_disabled_reftypes 
See discussion in sphinx-doc/sphinx#9459
 2021-10-31 15:01:08 +01:00
Jakob Lykke Andersen
4c19d9f65a Merge branch '4.x' 2021-10-31 14:44:45 +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
Takeshi KOMIYA
4c623237c1 Merge branch '4.x' 2021-10-28 02:43:32 +09: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
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
080bb71afa Merge branch '4.x' 2021-10-23 01:25:00 +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
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
3f51f1a6cf Merge branch '4.x' 2021-10-09 13:50:50 +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
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
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
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
ca146ac18b Close #9623: Allow to suppress warnings on excluded document found in toctree 2021-09-12 19:23:19 +09:00
Takeshi KOMIYA
3d8fbd992c Merge branch '4.x' 2021-09-12 16:56:34 +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
Takeshi KOMIYA
2c21e91b5f Merge branch '4.x' 2021-09-11 17:13:21 +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
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
Nicolas Delon
bf588c42b2 Fix typo in autodoc documentation 2021-08-25 23:42:27 +02:00
Takeshi KOMIYA
d194e0f490 Merge branch '4.x' 2021-08-21 21:03:30 +09: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