sphinx

0 Fork 0

mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-10-25 22:50:22 -05:00

Author	SHA1	Message	Date
Adam Turner	9a8eeac865	Use granular syntax highlighting for the Napoleon extension	2025-01-26 04:45:49 +00:00
Adam Turner	a1c77f1725	Improve wording for the ``:type:``directive option warning (#13256 )	2025-01-23 14:11:57 +00:00
Adam Turner	42f300ee83	Rename the ``:nowrap` `and` `:nosignatures:`` directive options (#13264 ) Rename the ``:nowrap`` and ``:nosignatures:`` directive options to ``:no-wrap`` and ``:no-signatures:``, for readability. This mirrors changes already made to `:no-index`, `:no-index-entry`, `:no-contents-entry`, and `:no-search` in Sphinx 7.2 and 7.3.	2025-01-23 04:30:46 +00:00
Adam Turner	1b607502d5	Remove top-level modules from the no-any-generics whitelist	2025-01-22 02:24:55 +00:00
Thomas Louf Bénédikt Tran Adam Turner Jakob Lykke Andersen	1418339eb9	Allow configuration of trailing commas in multi-line signatures (#12975 ) Stop outputting trailing commas for C and C++, as it is invalid syntax. Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>	2025-01-21 20:08:18 +00:00
Adam Turner	e18155fa10	Note when ``.. confval::`` was added	2025-01-21 08:08:29 +00:00
Adam Turner	5b3f98ed80	Sort the ``suppress_warnings`` list and add missing entries	2025-01-21 08:06:19 +00:00
Bénédikt TranandAdam Turner	5b9fb9e060	autodoc: fix ordering of class and static methods for `groupwise` order (#13201 ) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>	2025-01-20 15:19:05 +00:00
CyrilRoelandteNovanceandAdam Turner	34037aa4ad	Allow users to suppress ``autodoc.mocked_object`` warnings (#9732 ) Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>	2025-01-19 23:12:40 +00:00
Slawomir FigielandAdam Turner	67f6154be3	Allow suppressing warnings for non-matching ``toctree`` glob patterns (#13230 ) Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>	2025-01-16 18:17:21 +00:00
Adam Turner	182c831c7d	Disambiguate ``:type:`` as a directive option or info-field-list item (#13242 )	2025-01-15 00:20:42 +00:00
Adam Turner	d102e62bc7	Format code blocks in docstrings	2025-01-14 12:17:46 +00:00
Adam Turner	72ce43619c	Remove unneeded runtime typing imports (#13233 )	2025-01-12 01:04:14 +00:00
Adam Turner	fdb1b0cdad	Update documentation for the ``:no-search:`` file-wide metadata option	2025-01-10 16:56:21 +00:00
Adam Turner	d42cfa702f	Further minor copyediting of the 'extension metadata' section	2025-01-10 01:26:17 +00:00
Adam Turner	daade2715a	Rewrite the 'extension metadata' section	2025-01-10 01:09:49 +00:00
Adam Turner	44aced1ab7	Add types and defaults to confval directives (#13218 )	2025-01-07 03:55:27 +00:00
Adam Turner	a69d79bf67	Add .gitattributes	2025-01-06 21:55:29 +00:00
FireflyandAdam Turner	717dcc531a	Napoleon: Define confval types and defaults (#13094 ) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>	2025-01-05 11:05:12 +00:00
Adam Turner	83bf866059	Avoid attribute indirection with ``env`` (#13212 )	2025-01-05 09:10:55 +00:00
James AddisonandAdam Turner	872d270f10	linkcheck: support ignored-URIs for redirects (#13127 ) Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>	2025-01-05 01:20:15 +00:00
Tim HoffmannandAdam Turner	432bc5e50b	Add a class option to the autosummary directive (#13144 ) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>	2025-01-04 00:28:59 +00:00
Adam Turner	e65bbb96ae	Create a new type for the current document's environment state (#13151 )	2025-01-04 00:28:03 +00:00
Nicolas PeugnetandAdam Turner	0fbf88a59f	Allow extensions to define the keys returned by linkcode (#11824 ) Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>	2025-01-03 21:28:34 +00:00
Julien LecomteandAdam Turner	fddbd7d151	Add new ``duplicate_declaration.{c,cpp}`` warning types (#13173 ) Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>	2025-01-03 02:48:07 +00:00
Adam Turner	ff2693242d	Run Ruff on ``doc/usage/extensions/``	2025-01-02 23:59:48 +00:00
Adam Turner	b5f9ac8afc	Enable the RUF100 lint in Ruff	2025-01-02 23:49:43 +00:00
Jean-François B.	df3d94ffda	Close #13130 (LaTeX docs about index creation) (#13139 )	2024-12-02 11:12:22 +01:00
Rubén de Celis Hernández	6a8d70a2fd	Fix incorrect reference to ``--config-dir`` in the documentation (#13148 ) The correct argument name is ``--conf-dir``.	2024-11-22 17:03:18 +00:00
Adam Turner	58b2a94770	Set 'persist-credentials' to false	2024-11-16 18:30:17 +00:00
James AddisonandAdam Turner	c93723b803	singlehtml: deprecate the 'fix_refuris' helper function (#13037 ) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>	2024-11-13 23:15:00 +00:00
Tim Hoffmann	20b53bcc1a	Add a graph illustrating the build phases to the docs (#13108 )	2024-11-13 22:22:47 +00:00
Tim HoffmannandAdam Turner	a2db696777	Format options for doctest directives (#13107 ) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>	2024-11-13 22:20:56 +00:00
Santos Gallegos	2320c46b9e	Document ``Sphinx.set_html_assets_policy`` (#13123 )	2024-11-13 22:10:03 +00:00
Tim HoffmannandAdam Turner	8117bcaae8	Format autosummary options in docs (#13106 ) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>	2024-11-07 16:25:40 +00:00
Adam Turner	1266c421be	Use pathlib in ``sys.path`` manipulation examples	2024-11-03 22:58:19 +00:00
Adam Turner	801c60a873	Consistently calculate the current file's directory	2024-11-03 17:28:02 +00:00
Adam Turner	a6559d496b	Use pathlib in examples	2024-11-03 17:26:39 +00:00
Rafael Fontenelle	db1a190c58	Use default locale_dirs value (#13079 )	2024-11-02 23:47:24 +00:00
Adam Turner	116a430cac	Accept `PathLike` in `Sphinx.add_message_catalog()`	2024-10-25 22:49:51 +01:00
Rafael Fontenelle	a993a52f37	Fix locale_dirs default value in documentation (#13052 )	2024-10-21 01:04:37 +01:00
Adam Turner	541bf7bc67	Drop support for Python 3.10 (#13000 )	2024-10-17 20:59:41 +01:00
Adam Turner	90db3e1b89	Move Sphinx 8.1 CHANGES to doc/changes	2024-10-17 19:35:29 +01:00
Jared DillardandAdam Turner	5a4859a2e4	Add docs about sphinx-autobuild (#13011 ) Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>	2024-10-12 19:07:23 +01:00
danieleades	05679efe7b	Type-check the 'autodoc_intenum' example (#12827 )	2024-10-12 01:14:56 +01:00
Tim Hoffmann Chris Sewell Adam Turner	b6269d3790	Improve documentation for the Builder API (#13008 ) Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com> Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>	2024-10-12 00:21:34 +01:00
Adam Turner	c46abc4721	Improve clarity for ``master_doc` `and` `root_doc``	2024-10-12 00:16:18 +01:00
Chris Sewell	c23697aaa7	Use method colour key in the Builder API graph (#12998 )	2024-10-11 22:51:32 +01:00
Tim HoffmannandAdam Turner	283d863af1	Minor cleanup to autosectionlabel docs (#12992 ) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>	2024-10-10 16:23:54 +01:00
James AddisonandAdam Turner	566d1cd20f	Reword a paragraph in latex_table_style's documentation (#12994 ) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>	2024-10-10 16:22:05 +01:00

1 2 3 4 5 ...