Adam Turner
ff20efcd7e
Tweaks to `doctest_show_successes` ( #11535 )
2023-07-28 22:29:04 +01:00
Trey Hunner
aef5445153
Add `doctest_show_success option to sphinx.ext.doctest` ( #10938 )
...
For documentation that includes *many* doctests,
seeing both successes and failures can add a lot of noise to the command output.
This change adds a ``doctest_show_success`` option that,
when set to ``False``, will only show doctest failures.
2023-07-28 22:16:38 +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
Téo Bouvard
05a14ff007
Don't filter `ImportWarning in ext.autodoc.importer` ( #11024 )
2023-07-28 17:53:49 +01:00
Val Lorentz
eb3fffc3e9
Pre-compile all `excludes regular expressions in apidoc` ( #10981 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-07-28 17:31:56 +01:00
Chris Lamb
f0fead5351
Change the default value of `locale_dir to None` ( #11037 )
...
The ``locale_dir`` keyword argument for the ``init_console()`` method
defaults to the path that method is implemented in (via ``__file__``),
and then that (non-deterministic) default argument is included in Sphinx's own documentation.
This makes the build unreproducible as it varies
depending on the directory you create the documentation from.
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-07-28 16:58:05 +01:00
Adam Turner
c9f0e67cca
Add `sphinx.util.index_entries` ( #11528 )
2023-07-28 07:41:10 +01:00
Christoph Hasse
fca33a203d
Add additional `stringify_annotation` tests ( #11027 )
2023-07-28 06:45:20 +01:00
Adam Turner
d779a1c53e
Move `split_full_qualified_name() to ext.autosummary.generate`
2023-07-28 06:29:45 +01:00
Adam Turner
58585a7c0a
Unify `get_full_modname`
2023-07-28 06:27:46 +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
Adam Turner
7cce00aa7d
Refactor `sphinx.util.inspect` and tests ( #11527 )
2023-07-28 02:05:40 +01:00
Adam Turner
c9d4a1a204
Correctly copy extentionless template files
2023-07-28 00:49:53 +01:00
Adam Turner
49d8304670
Start using `pathlib.Path and deprecate sphinx.testing.path` ( #11526 )
2023-07-28 00:39:12 +01:00
Kayce Basques
23c7fdde75
Differentiate the colour of previously-visited hyperlinks ( #11390 )
...
Add ``a:visited`` to the CSS templates
2023-07-27 23:02:14 +01:00
James Addison
467e94dc62
object inspection: produce deterministic descriptions for nested collection datastructures ( #11312 )
...
``util.inspect.object_description`` already attempts to sort collections, but this can fail.
This commit handles the failure case by using string-based object descriptions
as a fallback deterministic sort ordering, and protects against recursive collections.
Co-authored-by: Chris Lamb <lamby@debian.org>
Co-authored-by: Faidon Liambotis <paravoid@debian.org>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-07-27 22:45:51 +01:00
Adam Turner
7d16dc0cac
Use `time.strftime` for date formatting in the EUPB builder ( #11525 )
...
When ``language`` is hardcoded to English, we can avoid the indirection of
``sphinx.util.i18n.format_date`` and Babel.
2023-07-27 22:11:15 +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
a54e630a21
[internationalisation] Update message catalogues
2023-07-27 21:34:26 +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
cb6d568715
Enable `strict-optional` for several more modules ( #11523 )
...
This enables mypy's ``strict-optional`` mode for:
* ``sphinx.builders.html``
* ``sphinx.builders.latex``
* ``sphinx.domains.python``
* ``sphinx.domains.std``
* ``sphinx.environment``
* ``sphinx.ext.apidoc``
* ``sphinx.ext.autodoc``
* ``sphinx.ext.autodoc.importer``
* ``sphinx.ext.autosummary``
* ``sphinx.ext.autosummary.generate``
* ``sphinx.ext.inheritance_diagram``
* ``sphinx.ext.intersphinx``
* ``sphinx.ext.imgmath``
* ``sphinx.ext.mathjax``
* ``sphinx.ext.napoleon.docstring``
* ``sphinx.registry``
* ``sphinx.writers.latex``
2023-07-27 20:17:35 +01:00
picnixz
5233086b8c
Add `tests/test-server.lock to .gitignore` ( #11520 )
2023-07-27 17:58:32 +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
ad61e41157
Drop support for Python 3.8 ( #11511 )
2023-07-25 02:07:23 +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
0882914d5c
Target PyPI in create-release.yml
2023-07-24 16:52:37 +01:00
Adam Turner
21fbee5e83
Fix OIDC token payload
2023-07-24 16:42:36 +01:00
Adam Turner
1a403e4f9a
Add informational log messaging
2023-07-24 16:39:15 +01:00
Adam Turner
258b0ea9fc
Revert "Switch to using `github.request`"
...
This reverts commit f9c89e5d84
2023-07-24 16:30:36 +01:00
Adam Turner
f9c89e5d84
Switch to using `github.request`
2023-07-24 16:08:01 +01:00
Adam Turner
52c7f66ce1
Use the correct token minting URL for TestPyPI
2023-07-24 15:40:25 +01:00
Adam Turner
6079f28faa
Install twine in PyPI publish workflow
2023-07-24 15:26:17 +01:00
Adam Turner
3d43b9efdb
Fix github-script syntax in create-release.yml
2023-07-24 15:20:28 +01:00
Adam Turner
a539ce78f5
Add GitHub Actions environment; fix variable names
2023-07-24 15:12:46 +01:00
Adam Turner
c161e9c286
Publish releases to PyPI
...
Implement the PyPI trusted publisher OIDC flow within GitHub Actions.
2023-07-24 14:58:06 +01:00
github-actions[bot]
05c3ad0327
[bot]: Update message catalogues ( #11255 )
...
Co-authored-by: AA-Turner <AA-Turner@users.noreply.github.com>
2023-07-24 13:45:52 +01:00
Adam Turner
5c31195e91
Include the translated string in babel error messages
2023-07-24 13:33:12 +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
Adam Turner
914c317a1e
Provide timezone information in `datetime.fromtimestamp`
...
Python 3.12 has deprecated ``datetime.utcfromtimestamp``,
use timezone-aware datetime objects instead.
2023-07-24 12:40:28 +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
