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

6015 Commits

Author SHA1 Message Date
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
picnixz
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
picnixz
1cb52d5664 Improve traceback messages in parallel builds (#11452) 2023-07-23 21:33:57 +01:00
Manuel Kaufmann
f4a47f1401 Keep the `translated` attribute on translated nodes (#11502) 
This particular commit ensures that the ``translated`` attribute
is retained on translated nodes so that developers may use it
to improve the experience on translations.
This attribute can be useful to calculate
the translated percentage of a particular document,
to visually mark paragraphs as not translated,
and many other applications.
 2023-07-23 21:00:24 +01:00
picnixz
12e7cff0b6 Allow using `rst_prolog` with a role in a document title (#11445) 
Fix the field list field name recognition regular expression to avoid false positives,
as interpreted text roles may not be field name blocks.

Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2023-07-23 17:14:01 +01:00
Adam Turner
343e149398 Merge branch '7.0.x' 
# Conflicts:
#	CHANGES
#	sphinx/__init__.py
 2023-05-12 22:57:09 +01:00
Adam Turner
d48cc783b6 Bump to 7.0.1 final 2023-05-12 22:48:41 +01:00
Willem
de6b18ac7d Remove remaining references to the setuptools integration (#11418) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2023-05-12 22:46:17 +01:00
Adam Turner
749af9561e Bump version 2023-05-12 13:57:37 +01:00
Jean-François B
53b9b28366 Update CHANGEs 2023-05-12 12:00:22 +02:00
Stefanie Molin
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
TLouf
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
c73628dfca Accept a version tuple in `app.require_sphinx()` 2023-05-11 13:50:45 +01:00
Adam Turner
ae206694e6 html builder: Append CRC32 checksum to asset URIs (#11415) 2023-05-11 05:19:31 +01:00
Adam Turner
706f5f9cc8 Warn on deprecated Python-specific index types (#11412) 2023-05-09 22:57:39 +01:00
Adam Turner
db546189ce Support Docutils 0.20 (#11411) 2023-05-09 21:00:04 +01:00
Adam Turner
b546879539 Bump version 2023-04-29 22:26:43 +01:00
Adam Turner
d568b2f4f7 Bump to 7.0.0 final 2023-04-29 22:25:57 +01:00
Adam Turner
6202087f91 Add a note to CHANGES for PR 11385 2023-04-28 12:04:41 +01:00
Adam Turner
3e3251d3ba Remove `HTMLTranslator and html5_ready from sphinx.builders.html` (#11383) 2023-04-28 11:01:14 +01:00
Adam Turner
77fd819a09 Remove deprecated `LaTeXTranslator.docclasses` attribute (#11382) 2023-04-28 10:50:57 +01:00
Adam Turner
4be56f3b7d Remove deprecated `style` key for HTML templates (#11381) 2023-04-28 10:41:59 +01:00
Adam Turner
49027a9ae6 Autosummary: Always emit grouped `ImportError` exceptions (#11380) 2023-04-28 10:32:04 +01:00
Adam Turner
a464c5851d Make the `env argument to Builder` subclasses required (#11379) 2023-04-28 10:25:57 +01:00
Adam Turner
d22e660347 Remove deprecated `sphinx.util.docutils.is_html5_writer_available()` function (#11378) 2023-04-28 10:14:53 +01:00
Adam Turner
ce606d82cd Removed deprecated `sphinx.util.get_matching_files()` function (#11373) 2023-04-28 09:55:14 +01:00
Adam Turner
262e1d9857 Remove deprecated `sphinx.io.read_doc()` function (#11372) 2023-04-27 16:01:14 +01:00
Adam Turner
24f476949d Remove deprecated `sphinx.pycode.ast.parse()` (#11371) 2023-04-27 15:18:44 +01:00
Adam Turner
583fb74bd4 Remove deprecated `sphinx.util.stemmer` module (#11370) 2023-04-27 14:53:51 +01:00
Adam Turner
3c4e78e236 Make `locale required in sphinx.util.i18n.format_date()` (#11366) 2023-04-27 01:30:40 +01:00
Adam Turner
ce5ce1ac2d Remove support for the `jsdump format in sphinx.search` (#11365) 2023-04-27 01:28:45 +01:00
Adam Turner
973e8fb5cf Remove the deprecated `sphinx.ext.napoleon.iterators` module (#11364) 2023-04-27 01:27:07 +01:00