IntenseWebs/sphinx
3
0 Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-10-14 17:32:12 -05:00
Code Issues Packages Projects Releases Wiki Activity
20,475 Commits 11 Branches 236 Tags
23c9cb4e781a2ea5b65023c488cb9c80f2ca33da
Commit Graph
865 Commits
Author SHA1 Message Date
Adam Turner 3d8b00827e Promote underline levels 2023-10-03 19:39:36 +01:00
Adam Turner 81a8870eee Note that cross-referencing syntax has moved to a new location 2023-10-03 19:39:36 +01:00
Adam Turner 6a56592b30 Move cross-referencing to a new page 2023-10-03 19:32:37 +01:00
Adam Turner 5d58624227 Reformat the domains lists 2023-10-02 13:10:26 +01:00
Adam Turner f7f41e6828 Fix and standardise markup 2023-10-02 13:10:26 +01:00
Adam Turner 3dd10e47d0 Add versionadded directives 2023-10-02 13:10:26 +01:00
Adam Turner e15fc04e53 Promote underline levels 2023-10-02 13:10:26 +01:00
Adam Turner 385a9193a7 Remove redundant labels 2023-10-02 13:10:26 +01:00
Adam Turner 607aadc660 Split out the Maths domain 2023-10-02 13:10:26 +01:00
Adam Turner c6dd47d2c8 Split out the reStructuredText domain 2023-10-02 13:10:26 +01:00
Adam Turner f6bafc7dad Split out the JavaScript domain 2023-10-02 13:10:25 +01:00
Adam Turner c8b2191059 Split out the Standard domain 2023-10-02 13:10:12 +01:00
Adam Turner de3266ab25 Split out the C++ domain 2023-10-02 13:10:12 +01:00
Adam Turner db6cc67f1a Split out the C domain 2023-10-02 13:10:12 +01:00
Adam Turner d491d3e04c Split out the Python domain 2023-10-02 13:10:12 +01:00
Adam Turner 05682f12a6 Restore `usage/restructuredtext/domains` 2023-10-02 13:10:11 +01:00
Adam Turner c0e17eca40 Move the domains reference up one level 2023-10-02 13:09:38 +01:00
Adam Turner b935915c57 Improve make-mode documentation (#11692) 2023-09-21 09:39:39 +01:00
Nikita Sobolev 1bd261c3a0 Fix a typo in the `:final:` option for methods (#11670) 2023-09-14 09:50:49 +01:00
Hugo van Kemenade 359edc34fc Use the Python 3 `print()` function in the documentation (#11683) 2023-09-14 09:45:20 +01:00
Adam Turner 7e9a2066c2 Be more ephemeral (in anchor link title text) 2023-08-12 05:30:38 +01:00
blaisep b0fe730146 Fix #11407 adjust the spelling in the example. 2023-07-30 15:08:49 +02: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
latosha-maltbaandAdam Turner 97d2c5da2f Add the `:no-typesetting:` option for only creating targets (#10478) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2023-07-28 19:43:27 +01:00
benkriklerandAdam Turner 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 LeitaoandAdam Turner 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 TurnerandManuel Kaufmann 066e0fabc6 Add translation progress information (#11509) 
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
 2023-07-24 20:19:31 +01:00
picnixzandAdam Turner 82bc15aec3 Enable skipping anchor verification on a per-URL basis (#11489) 
Add a new ``linkcheck_anchors_ignore_for_url`` configuration variable.

Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2023-07-24 12:15:42 +01:00
picnixzandAdam Turner 480630c649 Support PEP 695 and PEP 696 syntax in the Python domain (#11444) 
* Generic classes can be documented with ``.. py:class::`` using PEP 695 syntax:

  .. code:: rst

     .. py:class:: Sequence[T]

* Generic functions can be documented with ``.. py:function::`` using PEP 695 syntax:

  .. code:: rst

     .. py:function:: foo[T](x: T)

* Default values for type bounds are supported.

Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2023-07-23 23:22:40 +01:00
Adam Turner de3aa8a318 Replace non-functional Bitbucket URLs 
- ``sphinx-contrib`` has moved to GitHub
- Replace personal project links with links to the Bitbucket archive
 2023-07-14 06:52:25 +01:00
Stefanie MolinandAdam Turner e09d02e440 Allow `copyright` to contain multiple entries (#10983) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2023-05-11 22:43:48 +01:00
TLoufAdam TurnerJean-François BTLouf
 		86b07d4a97 Allow multi-line object description signatures (#11011) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Co-authored-by: Jean-François B <2589111+jfbu@users.noreply.github.com>
Co-authored-by: TLouf <loufthomas@gmail.com>
 2023-05-11 14:28:57 +01:00
Adam Turner 706f5f9cc8 Warn on deprecated Python-specific index types (#11412) 2023-05-09 22:57:39 +01:00
Adam Turner 2a9e805206 Remove the deprecated Setuptools integration (#11363) 2023-04-27 01:22:04 +01:00
Maciej Olko 5a6b2b16b6 Add link to Weblate's Sphinx docs in intl documentation (#11332) 
Add link to Weblate in intl documentation
 2023-04-16 21:21:57 +02: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
Adam Turner 4a3febb69a Add an option for displaying short `Literal` types (#11109) 
The new ``python_display_short_literal_types`` configuration option
for the ``py`` domain controls display of PEP 586 ``Literal`` types.
The 'short' format is inspired by PEP 604, using the bitwise OR operator
to distinguish the possible legal values for the argument.
 2023-04-05 13:07:25 +01:00
Jean-François B e1b15a5c11 Update doc and CHANGES for PR #11281 2023-04-03 11:12:41 +02:00
Hugo van Kemenade 318914fff2 Fix syntax in `:manpage:` role example (#11249) 2023-03-24 01:36:58 +00:00
Adam Turner f5c957597d Normalise spelling of Sphinx versions 2023-03-24 00:44:33 +00: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
Hugo van Kemenade ba4c67b1dc Display examples of roles in the documentation (#11226) 
Show examples of roles in the docs so we can see how they look. 
Seeing how roles are displayed helps us decide whether to use them.
 2023-03-17 15:05:09 +00:00
Mike Taves 23bf041ce4 Remove unicode prefix (`u`) from strings (#11158) 2023-02-15 04:37:33 +00:00
Hugo van Kemenade 7f62f539be Correct the Python Developer Guide markup style advice link (#11189) 2023-02-11 13:19:51 +00:00
Jean-François B ddf4daf2c6 Doc of html_file_suffix (closes #11141) (#11144) 2023-01-22 19:32:12 +01: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