Commit Graph
4138 Commits
Author SHA1 Message Date
Adam Turner 3dddb1c53a Remove project extras (optional dependencies) (#13445) 2025-08-02 14:37:55 +01:00
Tim HoffmannandAdam Turner 3fd98d868a Rename `sphinx.ext.jsmath to sphinxcontrib.jsmath` (#13788)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-07-31 09:59:13 +01:00
Adam Turner 5d3bb2e3b7 Support Docutils 0.22 (#13786) 2025-07-29 18:44:31 +01:00
Stephen Finucane 1adc61a7a2 Indicate preference for follow-up commits over force pushes (#13748) 2025-07-25 15:27:58 +01:00
Jean-François B. 7b4164a5f2 LaTeX: better choice for \tymax parameter (#13711) 2025-07-01 18:29:08 +00:00
Jean-François B. 5fd1462390 Update changes/5.3.rst to mention fix of #6740
Close #6740.
2025-06-30 18:01:03 +02:00
Jean-François B. 74c1686789 LaTeX: improve the table column widths computed by LaTeX itself
Fix #3447
Fix #8228

With this patch the legacy notion of "problematic cell" is almost
entirely removed, and LaTeX package tabulary will be used more often so
that column widths in tables may get better fit to actual contents.

This works well when the column contains cells with multiple paragraphs,
bullet lists, enumerated lists, or line blocks.  For cells with object
descriptions or admonitions, the column may not fit tightly to the
contents, but other columns will probably be improved.
2025-06-29 21:42:47 +02:00
Adam Turner 5221bfccd4 Refresh the list of third-party domains (#13691) 2025-06-24 01:20:48 +01:00
Adam Turner f1edefee45 Deprecate the `sphinx.io` module (#13682) 2025-06-19 11:53:44 +01:00
Adam Turner be6593b0de Prefer `current_document.docname` (#13669) 2025-06-16 20:37:08 +01:00
Adam Turner 551b842898 Deprecate support for source encodings other than UTF-8 (#13666) 2025-06-16 20:32:31 +01:00
Jean-François B. 076774224a Docs: clarify wording regarding default style for LaTeX tables (#13667) 2025-06-15 19:25:21 +00:00
Jean-François B. 4564486af4 LaTeX: clarify that latest docs addition refers to LaTeX 2025-06-11 10:05:28 +02:00
Jean-François B. f1316bb169 LaTeX: allow more cases of table nesting, fix #13646
Tables using longtable can now contain nested tables inclusive of those
rendered by tabulary, up to the suppression of the latter horizontal
lines due to an upstream LaTeX bug.  A longtable can never itself be
nested, and will fall-back to tabular.

Formerly longtable would raise (in principle) an error if it contained
any sort of nested table, but the detection of being a longtable was
faulty if not specified as class option.

Relates #6838.
2025-06-10 18:04:02 +02:00
Victor Wheeler 1580f5f7fd Note that the `:doc:` role is case-sensitive (#13587) 2025-06-08 20:41:45 +01:00
Victor WheelerandAdam Turner 39c81254de Update `extending_build.rst to match tutorials/example/todo.py` (#13515)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2025-06-08 20:35:36 +01:00
Melissa Weber MendonçaandAdam Turner 25ab3d7390 Document the `autolink` role for autosummary (#13596)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-06-07 17:24:56 +01:00
Tim HoffmannandAdam Turner 74627b25b0 Use anonymous references for links with embedded URLs (#13615)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2025-06-07 17:07:52 +01:00
Adam Turner 0b0c039c02 Deprecate remaining public `app` attributes (#13627) 2025-06-07 01:34:48 +01:00
Adam Turner 77a0d6658b Extract nested function definitions (#13625) 2025-06-06 22:27:18 +01:00
Jean-François B 1f2821e204 LaTeX: add support for fontawesome6 package 2025-05-25 17:02:27 +02:00
Victor Wheeler ad360fd634 Fix parameter lists for two event callback functions (#13516) 2025-05-21 02:34:39 +01:00
Adam Turner 75400aff91 Update stemming and Snowball (#13561) 2025-05-19 23:49:41 +01:00
Jean-François B. 6210799bf5 Revert "LaTeX: fix the #13525 fix of code-tex markup in docs"
This reverts commit 05137c25ac.

Sorry about that.
2025-05-14 13:45:38 +02:00
Jean-François B. 05137c25ac LaTeX: fix the #13525 fix of code-tex markup in docs 2025-05-14 10:03:49 +02:00
Yuki KobayashiandAdam Turner 491999f569 Docs: Fix `nested_parse` sample code (#13455)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-05-13 10:52:55 +01:00
Steve Piercy a27f37597a Emend the version changed note for `linkcheck_allowed_redirects` (#13550) 2025-05-12 23:43:12 +01:00
Shengyu Zhang c6e39d8584 Add missing backslashes in LaTeX documentation (#13525) 2025-05-12 19:29:18 +01:00
Hugo van Kemenade c4929d026c Fix typos (#13520) 2025-04-29 17:30:38 +01:00
James AddisonandAdam Turner a6d7ae1673 linkcheck: documentation and validation suggestions for linkcheck_allowed_redirects (#13458)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-04-01 15:11:31 +01:00
Adam Turner 3c4b4e3112 Warn on all redirects if `linkcheck_allowed_redirects` is an empty dictionary (#13452) 2025-03-27 19:03:43 +00:00
Till HoffmannandAdam Turner 5831b3eeaf Add `doctest_fail_fast` option to exit after the first failed test (#13332)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2025-03-24 19:44:16 +00:00
Victor WheelerandAdam Turner 05838f0e29 Add an introduction to HTML templating (#13430)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-03-20 01:05:14 +00:00
Justine Krejcha 457754b9d9 Correct "can be install" to "can be installed" (#13423) 2025-03-08 03:24:01 +00:00
Adam Turner 847ad0c991 Bump to 8.2.3 final 2025-03-02 22:29:09 +00:00
Adam Turner 4091fe3354 Add CHANGES for Sphinx 8.2.3 2025-03-02 22:26:39 +00:00
Adam Turner c84c21ff93 Correct the date for Sphinx 8.2.2 2025-03-02 22:23:35 +00:00
Adam Turner ee96ef3042 Bump to 8.2.2 final 2025-03-02 21:00:08 +00:00
Adam Turner 3e0021c7aa Move Sphinx 8.2.2 CHANGES to doc/changes 2025-03-02 20:52:47 +00:00
Dan Baston e7ca2d8eaf Add detail to changelog entry (#13385)
Update description of the fix for GH-13376, which also affected ``html_extra_path``.
2025-02-24 19:36:18 +00:00
Adam Turner 8e46d49ef0 Move Sphinx 8.2 CHANGES to doc/changes 2025-02-23 19:44:59 +00:00
Chris SewellandAdam Turner 179e24252b Add the `sphinx.ext.apidoc` extension (#13333)
A common use-case is that users simply want to point Sphinx
towards a Python module, and have it generate documentation
automatically.

This is not possible currently, without a "pre-build" step
of running the ``sphinx-autogen`` CLI.

This PR adds ``sphinx.ext.apidoc`` as a first-party extension,
to incorporate the source file generation into the Sphinx build.

Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2025-02-18 00:30:30 +00:00
Adam Turner 29a02c64e0 Update commit message recommendations 2025-02-15 22:09:27 +00:00
Adam Turner c49d925b4d Remove `productionlist` hard-coding in writers (#13326)
The ``productionlist`` directive operates in a line-based context, creating an ``addnodes.productionlist`` container
of ``addnodes.production`` nodes, with one per production in the directive. However, the full state of the abstract
document tree is not included in the produced nodes, with each builder/translator implementing a different way
of appending the fixed separator ``::=`` and justifying the displayed text.

This should not happen in the writer, and hard-coding such details hampers flexibility when documenting different
abstract grammars. We move the specific form of the ``.. productionlist::`` directive to the logic in the directive body
and have the writers apply minimal custom logic.

LaTeX changes written by Jean-François B.
2025-02-13 00:16:26 +00:00
Matthias GeierandAdam Turner 94563a398b Un-deprecate `sphinx.util.import_object` (#13330)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2025-02-11 19:07:27 +00:00
Adam TurnerandJakob Lykke Andersen 758dc81303 Add the `intersphinx_resolve_self` option (#13291)
Co-authored-by: Jakob Lykke Andersen <Jakob@caput.dk>
2025-02-03 17:50:46 +00:00
Adam Turner 774f8cc738 Add the new `py:deco` cross-reference role (#13292) 2025-02-03 01:07:38 +00:00
Walter DörwaldandAdam Turner 50fb4a9dbb Add :include-subclasses: option to sphinx.ext.inheritance_diagram (#8159)
When this option is given, all sub-classes of the classes listed as arguments to `inheritance-diagram` are included in the diagram.

This makes it possible to generate a complete inheritance tree by just listing the base class and adding `:include-subclasses:`.

This is different from specifying the module that contains this base class, as this module might include other classes that should not be part of the diagram.

Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2025-02-02 20:52:23 +00:00
Adam Turner 866881583a Shorten the `suppress_warnings` changes list 2025-01-30 01:38:35 +00:00
Tiger3018andAdam Turner af3bb3687c Use warning types and sub-types in more places (#11677)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2025-01-29 19:22:44 +00:00