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

4458 Commits

Author SHA1 Message Date
Adam Turner
d80eab689d Fix EM10{1,2} (exception must not use a string) 2023-08-13 22:11:15 +01:00
Adam Turner
b533ef1662 Fix DTZ00{0-4} (Do not use naive datetime objects) 2023-08-13 22:11:15 +01:00
Adam Turner
d4169a32e7 Use `parsedate_tz` in the linkcheck builder 2023-08-13 22:11:15 +01:00
Adam Turner
e010e24728 Fix B904 (raise exceptions with `raise ... from ...`) 2023-08-13 22:11:15 +01:00
Adam Turner
bbfd3cd248 Fix B023 (function definition does not bind loop variable) 2023-08-13 22:11:15 +01:00
Adam Turner
1dcc112608 Fix B006 (Do not use mutable data structures for argument defaults) 2023-08-13 22:11:15 +01:00
Adam Turner
92e60b3f15 Fix PGH003 (type: ignore comment must have parameters) 2023-08-13 22:11:15 +01:00
Adam Turner
e2ff04eafe Fix RES102 (Remove unnecessary parentheses) 2023-08-13 22:11:15 +01:00
picnixz
af38180a14 Allow inline links in first line of Google style docstrings (#11316) 2023-08-12 07:24:28 +01:00
Adam Turner
0a42d91e7e Fix `test_{html,latex}_warnings` 2023-08-12 06:40:55 +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
2ef9728b6e Mark idempotent translations as 'translated' (#11580) 2023-08-12 04:51:52 +01:00
Adam Turner
c19f0ac8e9 Clarify why `test_logging_in_ParallelTasks` fails on Windows 2023-08-12 04:24:09 +01:00
Adam Turner
1ea5a434b3 Fix `test_get_filename_for_language` on Windows 2023-08-12 04:23:56 +01:00
Adam Turner
1a47e3a8be Fix `test_missing_reference` on Windows 2023-08-12 04:23:48 +01:00
Adam Turner
8111a3a211 Fix `test_html_inventory` on Windows 2023-08-12 04:23:33 +01:00
Adam Turner
a392f4d5f4 Fix `test_graphviz_svg_html` on Windows 2023-08-12 02:57:55 +01:00
Adam Turner
58b628263f Deprecate `css_files and script_files` (#11582) 2023-08-12 00:46:44 +00:00
Adam Turner
818895a158 Placate `isort` 2023-08-12 00:27:13 +01:00
Adam Turner
42a6546404 Move `_file_checksum() to sphinx.builders.html._assets` 2023-08-12 00:20:00 +01:00
Adam Turner
44a7820cd9 Raise an error when local asset files contain a `?` 2023-08-11 22:07:07 +01:00
Adam Turner
177565584a Tighten Pytest configuration (#11577) 2023-08-10 20:48:04 +01:00
Adam Turner
b91d763db8 Fix PT011 (`pytest.raises(ValueError)` is too broad) 2023-08-10 13:11:25 +01:00
Adam Turner
78976662d9 Fix PT003 (implied `scope='function'`) 2023-08-10 13:11:25 +01:00
Adam Turner
fb5b80c340 Fix PT007 (use lists in `pytest.mark.parametrize`) 2023-08-10 13:11:24 +01:00
Adam Turner
02e011e4ff Fix PT006 (use tuples in `pytest.mark.parametrize`) 2023-08-10 13:00:48 +01:00
Adam Turner
976dd07ffe Require Pygments 2.14 or later (#11576) 2023-08-10 11:35:45 +00:00
Adam Turner
8cabf08668 Cache the docname<->filename map in `Project` instances (#11575) 2023-08-10 12:25:38 +01:00
Adam Turner
4dd2ed4bde Spring-clean `test_build_gettext` (#11573) 2023-08-10 09:20:48 +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
Adam Turner
6f5a99a05d Refactor `sphinx.environment.adapters.TocTree` (#11565) 2023-08-09 15:43:26 +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
8cd677f929 Add a new test for `_file_checksum` 2023-08-07 21:51:25 +01:00
Adam Turner
85ffb3b0fd Fix `test_assets_order` for Pygments 2.16 2023-08-07 21:51:05 +01:00
Adam Turner
083d573b7c Fix `test_dark_style` for Pygments 2.16 2023-08-07 21:04:14 +01:00
Dmitry Shachnev
8a990db49e Update `test_captioned_code_block` for latest Docutils (#11551) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2023-08-05 04:46:41 +01:00
Adam Turner
43ab23a61f Merge branch '7.1.x' 
# Conflicts:
#	CHANGES
#	sphinx/__init__.py
 2023-08-02 02:58: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
Jean-François B
4958d2abf1 Fix flake8 E231 reported linting failure 2023-08-02 02:04:55 +01:00
Jean-François B
eb0499a696 Fix flake8 E231 reported linting failure 2023-07-30 15:00:55 +02:00
Adam Turner
629b862cde Spring-clean `sphinx.testing.utils` (#11534) 2023-07-28 23:24:13 +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
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
Christoph Hasse
fca33a203d Add additional `stringify_annotation` tests (#11027) 2023-07-28 06:45:20 +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
Martin Liška
2c0b81d88b Refactor `test_attrgetter_using` (#11293) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2023-07-28 04:20:36 +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