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,470 Commits 2 Branches 219 Tags
9c3b50b31c4d71b28c61fcd17c110d327e7bf8fe
Commit Graph

3751 Commits

Author SHA1 Message Date
Shengyu Zhang
9c3b50b31c Avoid hard-coding 'index' for the master document in templates (#11801) 2023-12-28 07:05:14 +00:00
Hugo van Kemenade
aea69ea6af Add longer option names to `sphinx-build` (#11776) 
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2023-12-27 00:22:52 +00:00
Adam Turner
5730329d83 Simplify the font selection 2023-10-04 16:56:47 +01:00
Adam Turner
8878bee000 Replace the header image with a new SVG logo 2023-10-04 16:56:46 +01:00
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
909f93c7ec Use `pyproject.toml entry points rather than setup.py` 2023-10-03 19:26: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
9d1dcae373 Deprecate old-style Makefiles in sphinx-quickstart (#11693) 2023-09-21 10:25:00 +01:00
Bénédikt Tran
5fe0bd41eb Strip ANSI control codes when writing to the warnings file (#11624) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2023-09-21 10:01:07 +01:00
Adam Turner
b935915c57 Improve make-mode documentation (#11692) 2023-09-21 09:39:39 +01:00
Adam Turner
9298de548f Update CI configuration 
- Merge LaTeX and Coverage into the main CI file
- Only run tests when a relevant file changes
- Update ``actions/checkout``
- Set ``-Werror`` only on pytest steps
- Reduce verbosity on the documentation workflow
 2023-09-21 09:08:29 +01:00
Adam Turner
3ac143c8bf Enable nit-picky mode in `conf.py` 2023-09-21 09:02:58 +01:00
Adam Turner
655bd15749 Adorn top-level files with a '.rst' suffix 2023-09-14 11:08:17 +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
Matt Wozniski
43d69755df Leverage `importlib.reload` for reloading modules (#11679) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2023-09-13 22:58:35 +01:00
Adam Turner
ff18318613 Add an `'include-read'` event (#11657) 2023-08-30 22:21:16 +01:00
Bénédikt Tran
76658c49a9 Fix `sphinx.ext.autodoc.preserve_defaults` (#11550) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2023-08-17 01:19:25 +00:00
Bénédikt Tran
19018f01b6 Improve SigElementFallbackTransform fallback logic. (#11311) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2023-08-15 14:25:25 +01:00
Matthias Geier
65fd5be20d Use the 'toctree-wrapper' class for the `sphinx13` theme (#11129) 2023-08-14 23:40:42 +01:00
Adam Turner
9bcf1d8bb3 Fix TCH001 (move application import into a type-checking block) 2023-08-14 00:18:13 +01:00
Adam Turner
36012b7d96 Fix TCH002 (move third-party import into a type-checking block) 2023-08-13 22:50:03 +01:00
Adam Turner
db739afaeb Update permissions in the tutorial deployment workflow 2023-08-12 06:42:33 +01:00
Adam Turner
7e9a2066c2 Be more ephemeral (in anchor link title text) 2023-08-12 05:30:38 +01:00
Adam Turner
58b628263f Deprecate `css_files and script_files` (#11582) 2023-08-12 00:46:44 +00: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-maltba
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
Adam Turner
c9f0e67cca Add `sphinx.util.index_entries` (#11528) 2023-07-28 07:41:10 +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
49d8304670 Start using `pathlib.Path and deprecate sphinx.testing.path` (#11526) 2023-07-28 00:39:12 +01:00
Adam Turner
5cf3dce36e Deprecate `md5 and sha1 wrappers in sphinx.util` (#11512) 2023-07-25 02:29:28 +01:00
Adam Turner
ad61e41157 Drop support for Python 3.8 (#11511) 2023-07-25 02:07:23 +01:00