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
Takeshi KOMIYA
8224f6f44a Fix #10181: napoleon_use_ivar adds unexpected prefix to vars 
Since 4.0, :ivar: items has not been rendered as hyperlinks.  So any
modules, classes and tilda are now harmful.  This removes the prefixing
filter for napoleon_use_ivar option.

refs: #5129 and #5977
 2022-02-12 00:50:56 +09:00
Daniel Townsend
bcb0a03f92
setup -> set up 2022-02-10 17:44:18 +00:00
Daniel Townsend
03c8ceb85f
improve grammar in theming.rst 2022-02-08 13:05:18 +00:00
Takeshi KOMIYA
680417a10d
Merge pull request #10150 from tk0miya/10146_autodoc_default_options_should_support_no-value 
Close #10146: autodoc: autodoc_default_options does not support `no-value` option
 2022-02-06 15:59:24 +09:00
Takeshi KOMIYA
7469096e0a
Update doc/usage/extensions/autodoc.rst 2022-02-06 15:30:54 +09:00
Noah Sprent
25c4287da5
Remove commas when describing characters for section headings 2022-02-02 10:52:06 +01:00
Takeshi KOMIYA
b0b51cecc2 Close #10146: autodoc: autodoc_default_options does not support no-value option 2022-01-31 01:51:37 +09:00
Takeshi KOMIYA
799385f555
Merge pull request #9337 from marxin/new-shortcuts 
Implement new search shortcuts.
 2022-01-31 00:11:45 +09:00
Timo Cornelius Metzger
8f39f29725 Update autosummary.rst 2022-01-27 20:22:45 -08:00
Martin Liska
8cf3179ad2 Implement new shortcuts: 
- "/" for Focus search bar
- "ESC" - clear highlighted text

Fixes #691.

Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
 2022-01-22 16:16:35 +01:00
Hinrich Mahler
84a6270685 Mention nitpick_ignore(_regex) in docs of warn-missing-reference 2022-01-18 22:01:52 +01:00
Takeshi KOMIYA
72bb5c998f Close #9456: html search: Add a config variable; html_show_search_summary 
refs: #9494
 2022-01-17 01:44:42 +09:00
Jakob Lykke Andersen
3bf8bcd6e1 intersphinx role, update docs 2022-01-16 09:48:20 +01:00
Jakob Lykke Andersen
540d76035c intersphinx role, documentation 2022-01-16 09:48:06 +01:00
Takeshi KOMIYA
d82d370739
Merge pull request #10078 from danieleades/refactor/unused-loop-control-variables 
address some unused loop control variables
 2022-01-16 02:46:32 +09:00
Takeshi KOMIYA
6611140c76 Merge branch '4.x' into HEAD 2022-01-15 19:46:45 +09:00
danieleades
9c68cd12d7
Update recipe.py 2022-01-14 08:58:54 +00:00
Daniel Eades
6697ed62ed address some unused loop control variables (B007) 2022-01-12 20:19:18 +00:00
Jean Abou Samra
0269bec1ed In translated docs, sort glossaries by translated terms 
This is done by moving the sorting from the glossary directive to a
transform operating after the i18n transform.

Closes #9827
 2022-01-12 16:47:40 +01:00
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