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,695 Commits 2 Branches 219 Tags
1cb47e0347b598bd79a7dcbfa70db35d0560952b
Commit Graph

3434 Commits

Author SHA1 Message Date
Martin Fischer
eab7efc333 doc: Linkify issue numbers in changelog to GitHub 2022-01-08 15:57:16 +01:00
Takeshi KOMIYA
fe338f603b Merge branch 'master' into 9595_deprecate_setuptools_integration 2022-01-02 18:18:01 +09:00
Takeshi KOMIYA
616f112e6a autodoc: The default of autodoc_typehints_format becomes to 'smart' 
The default value of autodoc_typehints_format configuration is changed
to `'smart'`.  It will suppress the leading module names of typehints
(ex. `io.StringIO` -> `StringIO`).

refs: #9075
 2022-01-02 17:35:19 +09:00
Takeshi KOMIYA
0663602bb9 Close #9595: Deprecate setuptools integration 2022-01-01 20:19:27 +09:00
Takeshi KOMIYA
ce8039db1f Merge branch '4.x' 2022-01-01 20:04:19 +09:00
Takeshi KOMIYA
f38bd8e952 Merge branch '4.3.x' into 4.x 2022-01-01 20:02:10 +09:00
Takeshi KOMIYA
6ee3dd1968 Merge branch '4.x' 2022-01-01 19:02:09 +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
4e8bca2f2f Merge branch '4.x' 2021-12-24 00:30:29 +09:00
Takeshi KOMIYA
03c915174e Merge pull request #9991 from tk0miya/9962_texinfo_definfoenclose 
Fix #9962: texinfo: Do not use @definfoenclose to empasize string
 2021-12-23 03:00:21 +09:00
Takeshi KOMIYA
bd84edb117 Fix #9962: texinfo: Do not use @definfoenclose to empasize string 
Since texinfo-6.8, `@definfoenclose` command has been deprecated. This
stops to use it to reduce the deprecation warning.

This also disables the customization the styles of emphasized text via
the command.
 2021-12-19 16:08:30 +09:00
Takeshi KOMIYA
733ac6ed5f doc: Update explanation of autodoc_unqualified_typehints (ref: #9931) 2021-12-18 15:26:42 +09:00
Takeshi KOMIYA
26cd8f100c Deprecate sphinx.writers.latex.LaTeXWriter.docclasses 2021-12-18 02:24:03 +09:00
Takeshi KOMIYA
5dc27f5948 Merge branch '4.x' 2021-12-17 02:09:33 +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
0e51ddef34 Merge branch '4.x' 2021-12-11 23:18:46 +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
Takeshi KOMIYA
980ccc4c2a Merge branch '4.x' 2021-12-10 01:45:15 +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
Agbonze Osazuwa
6f4280c0a3 Fixes statement typo 2021-12-04 13:13:17 +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
c45bf2ea32 Merge branch '4.x' 2021-11-28 01:09:10 +09: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
fae10db6ca Merge branch '4.x' 2021-11-23 18:17:32 +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
fafe688cbf Merge branch '4.x' 2021-11-22 02:34:31 +09: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
Takeshi KOMIYA
ecee2335c5 Merge branch '4.x' 2021-11-18 01:01:12 +09: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