Adam Turner
465b758a35
Extract `_generate_directives() from Documenter._generate()` ( #13985 )
2025-10-22 00:23:22 +01:00
Adam Turner
fdf5411c1c
Remove `DocumenterBridge` ( #13984 )
2025-10-21 19:06:53 +01:00
Adam Turner
b5870e6904
Extract the `_docstring_source_name()` function ( #13972 )
2025-10-19 19:31:15 +01:00
Adam Turner
c58caeffd7
Treat `Documenter.indent` as a constant ( #13960 )
2025-10-17 02:08:46 +01:00
Adam Turner
f194178967
Use a new `_best_object_type_for_member()` function ( #13961 )
2025-10-17 01:56:54 +01:00
Adam Turner
4c89a82c1d
Improve signature handling in autodoc ( #13955 )
2025-10-16 18:54:18 +01:00
ad3f3cc062
Add initial support for PEP 695 type aliases ( #13508 )
...
Signed-off-by: Martin Matous <m@matous.dev >
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com >
Co-authored-by: Jeremy Maitin-Shepard <jbms@google.com >
2025-10-10 01:41:42 +01:00
Stephen Finucane and Adam Turner
44a98961b2
Use hyphenated version directives ( #13714 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com >
2025-10-06 00:10:35 +01:00
Jared Dillard and Adam Turner
8dd7a23fec
Add warning sub-type for duplicate equation label warnings ( #13929 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com >
2025-10-05 03:59:09 +01:00
Tamika Nomara
e92900948e
Update list of maintained third-party domains ( #13919 )
2025-10-05 03:13:09 +01:00
Matthew Foster Walsh and Adam Turner
10af407c3e
Document `sphinx build -M help` ( #13881 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com >
2025-10-05 02:09:45 +00:00
Ugo
9a08711e0e
Correct the example for the `seealso` directive ( #13854 )
2025-08-27 10:54:15 +01:00
Ch3ri0ur
85a12e255a
Define the `code-py role in autosectionlabel.rst` ( #13819 )
2025-08-07 19:09:44 +01:00
duianto
01af04241b
Add filename caption to tutorial code block ( #13814 )
2025-08-05 14:41:48 +01:00
Jean-François B.
f92316a2f5
LaTeX: fix problems in our docs (in part inherited from #13805 ) ( #13809 )
2025-08-04 19:52:09 +02:00
Jean-François B.
5b3d92e7c6
LaTeX: support for using the fontawesome7 LaTeX package ( #13805 )
2025-08-04 09:55:36 +02:00
Adam Turner
67047523bf
Prefer `props._obj to documenter.object` ( #13804 )
2025-08-03 18:18:56 +01:00
Adam Turner
3dddb1c53a
Remove project extras (optional dependencies) ( #13445 )
2025-08-02 14:37:55 +01:00
Tim Hoffmann and Adam 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 Wheeler and Adam 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ça and Adam 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 Hoffmann and Adam 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 Kobayashi and Adam 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 Addison and Adam 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 Hoffmann and Adam 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 Wheeler and Adam 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