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,608 Commits 2 Branches 219 Tags
5bf0e3ad18c688ec681870b8564cefa089504cee
Commit Graph

3382 Commits

Author SHA1 Message Date
Takeshi KOMIYA
f38bd8e952 Merge branch '4.3.x' into 4.x 2022-01-01 20:02:10 +09:00
Takeshi KOMIYA
b84771dcd2 A happy new year! 2022-01-01 18:45:03 +09:00
Takeshi KOMIYA
a87153c018 autodoc: Rename autodoc_unqualified_typehints to autodoc_typehints_format (refs: #9931) 2021-12-24 10:14:19 +09:00
Takeshi KOMIYA
733ac6ed5f doc: Update explanation of autodoc_unqualified_typehints (ref: #9931) 2021-12-18 15:26:42 +09:00
Takeshi KOMIYA
f107ff4761 Merge pull request #9963 from tk0miya/refactor_doc 
doc: Use "console" for the highlight language of console output
 2021-12-16 01:37:39 +09:00
Takeshi KOMIYA
b1df3fa94b Merge pull request #9287 from ssbarnea/fix/irc 
Document new irc channel location
 2021-12-16 01:33:53 +09:00
Takeshi KOMIYA
dd27e35e4c doc: Use "console" for the highlight language of console output 
Using "console" language is better for the console example (including
command-line prompt)
 2021-12-13 14:20:37 +09:00
Takeshi KOMIYA
0b238d897c Fix #9108: docs: Use default pygments_theme to get accessiblity 
To increse accessiblity of our docs, this changes the pygments_theme of
sphinx-docs.org to "default".  It was updated to meet WCAG AA in
https://github.com/pygments/pygments/pull/1940.
 2021-12-11 11:34:51 +09:00
Takeshi KOMIYA
d3162d1ff2 Merge pull request #9931 from tk0miya/9075_autodoc_unqualified_typehints 
Close #9075: autodoc: Add a config variable autodoc_unqualified_typehints
 2021-12-11 10:59:23 +09:00
Takeshi KOMIYA
8d071a8e8f Merge branch '4.x' into texinfo-add-texinfo_emit_document_references 2021-12-11 10:27:50 +09:00
Christian Roth
10023da895 linkcheck: Exclude links from matched documents 2021-12-08 10:01:45 +01:00
Jouke Witteveen
e200e7b7c1 doc: Improve autodoc extension example 
Enumerations can have aliases, which should be documented as well.
 2021-12-06 12:31:09 +01:00
Takeshi KOMIYA
86639b7be9 Merge pull request #9852 from astrojuanlu/new-tutorial-deploying 
New Sphinx tutorial, part IV
 2021-12-04 12:02:23 +09:00
Takeshi KOMIYA
c71ff1cd21 Close #9075: autodoc: Add a config variable autodoc_unqualified_typehints 
If autodoc_unqualified_typehints feature enabled, autodoc suppresses the
leading module names of typehints of function signatures (ex.
`io.StringIO` -> `StringIO`)
 2021-12-03 18:05:49 +09:00
Jouke Witteveen
bc849e2170 doc: Fix autodoc extension example 
`directivetype` is set to mimic `ClassDocumenter`. Reflect that.

`isinstance` would work on the enum members, but that is not what we want here.
`issubclass` raises a TypeError when called on objects that are not classes.
 2021-12-02 16:50:09 +01:00
Takeshi KOMIYA
74d912133a Merge pull request #9800 from hoefling/extlinks/replacements-check 
Proposal: check if hardcoded URLs can be replaced with extlinks
 2021-11-29 09:36:55 +09:00
Juan Luis Cano Rodríguez
f6a3d037f4 Remove note to simplify message 2021-11-28 19:58:30 +01:00
Takeshi KOMIYA
15d834e4d8 Merge pull request #9831 from Yoshanuikabundi/autosummary___all__ 
Allow autosummary to respect __all__
 2021-11-26 02:15:43 +09:00
Takeshi KOMIYA
259de307ca Merge branch '4.3.x' into 4.x 2021-11-23 18:17:13 +09:00
Juan Luis Cano Rodríguez
d39c6861d9 Add note about .nojekyll file 2021-11-23 10:17:09 +01:00
Takeshi KOMIYA
a63fb55907 Merge pull request #9850 from astrojuanlu/new-tutorial-describing-code-other 
Add brief section on documenting other languages to tutorial
 2021-11-22 02:34:07 +09:00
Takeshi KOMIYA
e2c6146b3e Fix #9864: mathjax: Failed to render equations via MathJax v2 
MathJax library has been loaded via "defer" method since v4.3.0.  But
it prevents to work MathJax v2.  This rollbacks the change and use
"async" method as default again.

To support changing the loading method, this allows to specify it via
mathjax_options.
 2021-11-21 18:27:35 +09:00
Juan Luis Cano Rodríguez
79f6d40413 Apply suggestions from code review 
Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
 2021-11-18 23:04:30 +01:00
Juan Luis Cano Rodríguez
daceb8aba3 Document GitLab Pages 2021-11-18 19:34:09 +01:00
Juan Luis Cano Rodríguez
043b5e9253 Add missing content on dependencies 2021-11-18 18:47:39 +01:00
Juan Luis Cano Rodríguez
1d1b2296c5 Describe deployment on Read the Docs and GitHub Pages 2021-11-18 15:58:53 +01:00
Juan Luis Cano Rodríguez
142c5cf853 Write how to publish documentation sources 2021-11-18 10:35:28 +01:00
Juan Luis Cano Rodríguez
7045505eaf Change focus to be broader and more descriptive 2021-11-18 10:19:14 +01:00
Juan Luis Cano Rodríguez
f16f4a249b Finish background section on deployment 2021-11-17 21:37:01 +01:00
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
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