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,619 Commits 2 Branches 219 Tags 163 MiB
f4eea669e0
Commit Graph

304 Commits

Author SHA1 Message Date
Adam Turner
23cef9b59a Use `https://` where possible 2024-01-14 04:18:57 +00:00
Dimitri Papadopoulos Orfanos
460a63010f
Fix various spelling errors (#11735) 2024-01-04 02:37:44 +00:00
Adam Turner
b935915c57
Improve make-mode documentation (#11692) 2023-09-21 09:39:39 +01:00
Adam Turner
1cfb68d8be
Consistently name the object description options (#11533) 
*  The directive option ``:noindex:`` was renamed to ``:no-index:``.
*  The directive option ``:noindexentry:`` was renamed to ``:no-index-entry:``.
*  The directive option ``:nocontentsentry:`` was renamed to ``:no-contents-entry:``.

The previous names are retained as aliases, but will be deprecated
and removed in a future version of Sphinx (9.0 or later).
 2023-07-28 22:30:26 +01:00
Adam Turner
ff20efcd7e
Tweaks to `doctest_show_successes` (#11535) 2023-07-28 22:29:04 +01:00
benkrikler
762ed8540a
Add line numbers in `sphinx.ext.viewdoc` (#6319) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2023-07-28 05:52:48 +01:00
Jorge Leitao
99f9209924
Add summary statistics to the coverage report (#5474) 
The current implementation of ``sphinx.ext.coverage`` outputs which
methods,classes, and functions are documented.
This commit adds a short summary of this report in terms of
``documented objects / total number of objects``,
both per module and total.

The purpose of this is to support
a currently not mainstream but relevant use-case:
a coverage report on the number of objects that are documented.

By having the statistics on the report or on the stdout,
a regex expression can capture the coverage percentage
(e.g. ``re.search(r'TOTAL.*?([0-9.]{4,6}\%)', d).group(1)``)
and use it e.g. in another report, a status badge, etc.

Two options were added to the configuration to allow a table
to be printed in the report and/or to stdout.

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2023-07-28 02:33:42 +01:00
Adam Turner
ad61e41157
Drop support for Python 3.8 (#11511) 2023-07-25 02:07:23 +01:00
Adam Turner
7ecf037280 Enable 'nit-picky mode' for Sphinx's documentation 
Fix several reference errors throughout the documentation and set
``nitpick_ignore`` in ``doc/conf.py``.
 2023-04-06 23:11:39 +01:00
Jean-François B
e1b15a5c11 Update doc and CHANGES for PR #11281 2023-04-03 11:12:41 +02:00
Benjamin Balder Bach
eda388a506
Docs: Add a link to sphinx-extensions (#11260) 2023-03-23 08:33:16 +01:00
Adam Turner
2902c6c55b
Deprecate legacy `intersphinx_mapping` format (#11247) 
This format was made obsolete in Sphinx 1.0, but never formally deprecated.
 2023-03-17 16:41:22 +00:00
Adam Turner
670bcb743b
Documentation reshuffle (#11112) 2023-01-08 13:52:36 +00:00
Tim Hoffmann
ec26c2f874
Document autosummary template variable "objtype" (#11044) 2023-01-02 18:38:17 +00:00
Adam Turner
920828fe35 Run the `pyupgrade` tool 2022-10-17 22:39:09 +01:00
Martin Patz
3e29abf8de
Add debug logging to autosectionlabel (#10881) 
Co-authored-by: Martin Patz <martin@recogni.com>
 2022-10-04 15:25:06 +01:00
Julien Schueller
ef01c5b6bd
imgmath: Allow embedding images in HTML as base64 (#10816) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2022-09-23 17:11:21 +01:00
Adam Turner
ee005caf22 Do not apply epigraph style to all block quotes 
Correct indentation where appropriate for stanzas that should not be
rendered as `<blockquote>` HTML elements.

Closes GH-10686
 2022-09-12 19:54:36 +01:00
Abdur-Rahmaan Janhangeer
59056aa781
Remove extra line (#10749) 
Co-authored-by: Jean-François B. <2589111+jfbu@users.noreply.github.com>
 2022-08-04 18:42:55 +02:00
marxin
9a30edac7d Fix indentation of .. version{changed,added}. 2022-07-19 15:26:57 +02:00
Adam Turner
70f950cae0
Remove traces of Python 2 and 3.5 (#10560) 2022-06-16 21:37:46 +01:00
Julien Palard
956cddb7d4
Replace doclinter with sphinx-lint (#10389) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-06-16 19:32:09 +01:00
Takeshi KOMIYA
cab2d93076
Merge pull request #10386 from mxd4/10384-comment-img-magick 
Add comments on ImageMagick requirement
 2022-05-22 19:22:24 +09:00
mxd4
33b5e23467
#10384 - Grammar 2022-05-02 13:56:51 +02:00
mxd4
4fc196a2a5
#10384 - Fix flake8 2022-05-02 12:26:16 +02:00
mxd4
4d840c790c
#10384 - Explicit warning and improve doc clarity 2022-05-02 12:18:30 +02:00
mxd4
d2d5ce4eb6
#10384 - Changes after suggestions 2022-05-02 11:29:11 +02:00
mxd4
85524b5817
#10384 - Add line break to fix docslint 2022-05-02 11:15:29 +02:00
mxd4
930056479f
#10384 - Add comment on ImageMagick requirement 2022-05-02 10:47:56 +02:00
Stefaan Lippens
b98b1b3419
sphinx.ext.napoleon docs: fix Google style link 2022-04-25 12:35:40 +02:00
Takeshi KOMIYA
da73960492 Merge branch '5.x' into autodoc_force_undocumented_rtype 2022-04-03 22:45:42 +09:00
Takeshi KOMIYA
fd42063725 autodoc_typehints_description_target: Rename returnvalue_and_documented_params to documented_params 2022-04-03 22:42:44 +09:00
Takeshi KOMIYA
f731bf1999 Merge branch '5.x' into autodoc_force_undocumented_rtype 2022-04-03 22:29:22 +09:00
Takeshi KOMIYA
21e3a96f09 Close #8417: autodoc: :inherited-members: option now takes multiple classes 
It allows to suppress inherited members of several classes on the module at
once by specifying the option to `automodule` directive
 2022-04-03 20:17:41 +09:00
Takeshi KOMIYA
2db180da70 Merge branch '4.x' 2022-03-27 19:47:11 +09:00
Takeshi KOMIYA
c6230dc4db extlinks: Disable hardcoded links detector by default (refs: #10126) 
The hardcoded links detector added since 4.4.0 causes troubles in many
projects.  Therefore, this disables it by default, and adds a new
configuration `extlinks_detect_hardcoded_links` to enable it explicitly.
 2022-03-27 15:22:11 +09:00
Takeshi KOMIYA
fbdfade068 doc: Use :pep: role to refer PEP documents 2022-03-27 01:46:22 +09:00
Hugo van Kemenade
a432bf8c10 Update PEP links in docs 2022-03-24 12:34:05 +02:00
Takeshi KOMIYA
f72cd83e4d Merge branch '4.x' 2022-02-19 16:08:05 +09:00
Takeshi KOMIYA
8b23f6db12 Merge commit '07110b7557a552ecfe702bdd6a2d2f9685cb1af9' 2022-02-14 03:03:40 +09:00
Takeshi KOMIYA
7469096e0a
Update doc/usage/extensions/autodoc.rst 2022-02-06 15:30:54 +09:00
Takeshi KOMIYA
b0b51cecc2 Close #10146: autodoc: autodoc_default_options does not support no-value option 2022-01-31 01:51:37 +09:00
Timo Cornelius Metzger
8f39f29725 Update autosummary.rst 2022-01-27 20:22:45 -08:00
Takeshi KOMIYA
444dfc50aa Merge branch '4.x' 2022-01-17 00:22:09 +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
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
6ee3dd1968 Merge branch '4.x' 2022-01-01 19:02:09 +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