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,340 Commits 2 Branches 219 Tags
ddf8a8e7d4756170d5ee6dff7fc88ecd12912e59
Commit Graph

6046 Commits

Author SHA1 Message Date
Adam Turner
ddf8a8e7d4 Add CHANGES entry for GH-11533 2023-08-16 23:27:51 +01:00
Adam Turner
2b9ee41f27 Consolidate `sys.argv` handling 2023-08-16 23:22:14 +01:00
Stephen Finucane
53a930f8c7 Fix C coverage support in `sphinx.ext.coverage` (#11591) 2023-08-15 14:50:15 +01: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
picnixz
2656f34848 Fix rendering of `Literal` annotations with enum values (#11517) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2023-08-14 23:33:57 +01:00
Riccardo Mori
137b3adce1 Make stringify_annotation recursive on builtins with args (#11570) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2023-08-14 19:28:12 +01:00
Halldor Fannar
0bad447070 Emit "source-read" events for files read via the `include` directive (#11510) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Co-authored-by: picnixz <10796600+picnixz@users.noreply.github.com>
 2023-08-14 16:02:04 +01:00
Dmitry Shachnev
449020ec3d Highlight all search terms on the search results page (#10930) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2023-08-12 06:57:34 +00:00
picnixz
af38180a14 Allow inline links in first line of Google style docstrings (#11316) 2023-08-12 07:24:28 +01:00
Adam Turner
7d8df06e19 Relax Pygments parsing on lexing failures 2023-08-12 06:27:16 +01:00
Adam Turner
7e9a2066c2 Be more ephemeral (in anchor link title text) 2023-08-12 05:30:38 +01:00
Adam Turner
0e2ba0a1e4 Add CHANGES entry for GH-11546 2023-08-12 05:00:41 +01:00
Adam Turner
b3e3c1add9 Raise an error if `graphviz_dot` is falsy 2023-08-12 04:58:20 +01:00
Adam Turner
58b628263f Deprecate `css_files and script_files` (#11582) 2023-08-12 00:46:44 +00:00
Eric Larson
7758e01623 Provide the reason why a document is out of date in all cases (#11572) 2023-08-11 00:12:44 +01:00
Adam Turner
e7cd97e9f4 Correct a typo in CHANGES (c.f. #10938) 2023-08-10 23:24:12 +01:00
Adam Turner
177565584a Tighten Pytest configuration (#11577) 2023-08-10 20:48:04 +01:00
Adam Turner
976dd07ffe Require Pygments 2.14 or later (#11576) 2023-08-10 11:35:45 +00:00
alvinhochun
c52d55ebd7 Exclude substitution definitions from the `gettext` builder (#9846) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2023-08-10 10:01:25 +01:00
Albert Y. Shih
3e30fa36a2 Fix missing and broken links in inheritance diagrams (#10614) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2023-08-08 20:32:58 +01:00
grayjk
ac2b7599d2 autosummary: Extract summary line after "e.g." (#11196) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2023-08-07 22:20:30 +01:00
Adam Turner
43ab23a61f Merge branch '7.1.x' 
# Conflicts:
#	CHANGES
#	sphinx/__init__.py
 2023-08-02 02:58:30 +01:00
Adam Turner
320d0b631c Bump to 7.1.2 final 2023-08-02 02:56:30 +01:00
James Addison
06c1339bb3 Ensure that `linkcheck_anchors` is properly respected (#11544) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2023-08-02 02:55:37 +01:00
James Addison
89808c6f49 Emend attribution for GH-11431 in CHANGES (#11547) 2023-08-02 02:08:06 +01:00
James Addison
a549c67615 Emend attribution for GH-11431 in CHANGES (#11547) 2023-08-02 02:06:49 +01:00
Adam Turner
4862da883f Bump version 2023-08-02 01:55:23 +01:00
Jean-François B
0003c6a79d Update CHANGES for PR #11530 2023-07-30 14:52:20 +02:00
Adam Turner
ff20efcd7e Tweaks to `doctest_show_successes` (#11535) 2023-07-28 22:29:04 +01:00
Rouslan Korneychuk
d1b09b04c2 Added TOC object entry support for the C++ domain (#11221) 
When ``toc_object_entries_show_parents = 'domain'`` in the config,
the TOC entries omit the namespaces added by the ``cpp:namespace`` and ``cpp:namespace-push`` directives.

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2023-07-28 20:14:49 +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
Ralf Grubenmann
6178163cb1 Fix relative references in SVGs generated by `sphinx.ext.graphviz` (#11078) 
Co-authored-by: Ralf Grubenmann <ralf.grubenmann@gmail.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2023-07-28 05:47:23 +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
a01e1a21ac Merge branch '7.1.x' 
# Conflicts:
#	CHANGES
#	sphinx/__init__.py
#	sphinx/config.py
 2023-07-27 21:38:35 +01:00
Adam Turner
d8d73c16b8 Bump to 7.1.1 final 2023-07-27 21:35:23 +01:00
Adam Turner
8452300d54 Fix multi-line copyright when `SOURCE_DATE_EPOCH` is set (#11524) 
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
 2023-07-27 21:27:14 +01:00
Adam Turner
fe08cec019 bump version 2023-07-27 20:20:33 +01:00
Adam Turner
5cf3dce36e Deprecate `md5 and sha1 wrappers in sphinx.util` (#11512) 2023-07-25 02:29:28 +01:00
Adam Turner
f804da4b45 Add changelog entry for removal of Python 3.8 support 2023-07-25 02:09:21 +01:00
Adam Turner
80ec979861 Bump version 2023-07-24 23:49:56 +01:00
Adam Turner
e560f6334a Bump to 7.1.0 final 2023-07-24 20:34:10 +01:00
Adam Turner
066e0fabc6 Add translation progress information (#11509) 
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
 2023-07-24 20:19:31 +01:00
Adam Turner
1437d2a746 Reduce heading underline length for "Testing" 2023-07-24 13:00:29 +01:00
Adam Turner
dc14b4288e Update CHANGES for Sphinx 7.1.0 2023-07-24 12:51:58 +01:00
picnixz
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
James Addison
d15a837c61 Emend hyperlinks within the CHANGES and EXAMPLES (#11506) 
* Remove "dead" links
* Update project links to the correct hostnames
 2023-07-24 11:49:44 +01:00
picnixz
e11bf76919 Fix `MemoryError in sphinx.ext.intersphinx when using None or typing.*` as inline type references (#11338) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2023-07-24 11:35:12 +01:00