IntenseWebs/sphinx
3
0 Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-10-24 22:27:52 -05:00
Code Issues Packages Projects Releases Wiki Activity
22,408 Commits 4 Branches 238 Tags
15b45be903f4eae905da559df1e3120a209d3592
Commit Graph
119 Commits
Author SHA1 Message Date
gerhardtgao 964424b3db Use the correct reference for using existing extensions (#14157) 2025-12-27 03:01:42 +00:00
Adam Turner 4ba30e2835 Restore the legacy implementation of autodoc for compatibility (#14091) 2025-11-25 07:04:14 +00:00
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
Adam Turner 67047523bf Prefer `props._obj to documenter.object` (#13804) 2025-08-03 18:18:56 +01:00
Adam Turner be6593b0de Prefer `current_document.docname` (#13669) 2025-06-16 20:37:08 +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
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
Adam Turner 72ce43619c Remove unneeded runtime typing imports (#13233) 2025-01-12 01:04:14 +00:00
Adam Turner 83bf866059 Avoid attribute indirection with `env` (#13212) 2025-01-05 09:10:55 +00:00
Adam Turner 1266c421be Use pathlib in `sys.path` manipulation examples 2024-11-03 22:58:19 +00:00
Adam Turner a6559d496b Use pathlib in examples 2024-11-03 17:26:39 +00:00
danieleades 05679efe7b Type-check the 'autodoc_intenum' example (#12827) 2024-10-12 01:14:56 +01:00
Adam Turner c46abc4721 Improve clarity for `master_doc and root_doc` 2024-10-12 00:16:18 +01:00
James AddisonandTim Hoffmann 92f024e2bf HTML search: adjustments to type-dependent CSS classnames and defaults (#12815) 
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
 2024-09-18 03:40:20 +01:00
Wei-Hsiang (Matt) Wang e35e7b0fbe Remove unnecessary `:func: and :meth:` parentheses (#12848) 2024-09-01 06:33:28 +01:00
Tim HoffmannAdam TurnerJames Addison
 		646a5d7482 Support type-dependent search result highlighting via CSS (#12474) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Co-authored-by: James Addison <55152140+jayaddison@users.noreply.github.com>
 2024-08-11 20:22:21 +01:00
Adam Turner 18fbced7e0 Reduce the formatter's target line length to 88 (#12757) 2024-08-11 00:19:50 +01:00
Adam Turner b88905b6f7 Use long options to sphinx-build in our documentation 2024-07-24 15:21:25 +01:00
Adam Turner eb2186490a Use `copyfile` where possible 2024-07-23 22:36:10 +01:00
Adam Turner 7b570c06a1 Standardise on a common directive for describing code snippets 2024-07-15 02:15:52 +01:00
Adam Turner f2640a4286 Standardise on "reStructuredText" over "reST" in documentation 2024-07-15 02:15:52 +01:00
Adam Turner 1887df0b5c Add reStructuredText parsing functions to `SphinxDirective` (#12492) 2024-07-02 22:14:19 +01:00
Chris Sewell d130c2e710 [docs] Improve tutorials (#12473) 
This commit make it clearer, from the filenames and titles,
what the extension tutorials are intended to teach.
 2024-06-27 22:30:03 +02:00
Chris Sewell 8f97fd276a [docs] Improve landing page (#12453) 
This commit is intended to improve new user's first-interaction with the Sphinx site:

- Make page header icon/text smaller and not capitalized
- Give min-width to left sidebar (it was getting too small at certain window sizes)
- Replace features list on landing page with admonition boxes, with adaptive layout
- Add landing page "used by" section
- Slightly restructure the Extension section, into Tutorials and How-tos
- Add code to `conf.py` to write HTML write redirect pages for moved documents
- Improve support page, by adding link to Stackoverflow, GH discussion and ReadtheDocs,
  and remove defunct link to libera chat and matplotlib tutorial
 2024-06-21 20:12:57 +02:00
Matthias Geier 13b0fcc532 DOC: Add env_version to "todo" tutorial (#12349) 2024-05-05 19:04:10 +02:00
Matthias Geier afcafe0409 DOC: add data_version to "recipe" tutorial (#12350) 2024-05-05 19:02:54 +02:00
Matthias GeierandAdam Turner 76497988cb Return `parallel_read_safe` in the autodoc_intenum tutorial (#12288) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2024-04-26 01:49:04 +01:00
James AddisonandAdam Turner 0806a00f05 Support `.jinja` for theme static templates (#11916) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2024-04-23 10:40:24 +01:00
Adam Turner 254bfe4f4e Add `theme.toml` migration tool 2024-04-11 19:01:17 +01:00
Adam Turner 8976fa4498 Support `theme.toml` 2024-04-11 19:01:17 +01:00
Adam Turner 9ebfadbcad Create subsection for theme configuration 2024-04-09 18:34:55 +01:00
Bénédikt Tran f44ff30673 [doc] cleanup references and update external URLs (#12182) 2024-03-25 11:39:05 +01:00
Chris SewellandBénédikt Tran d59b158371 👌 Make ExtensionMetadata type public and use it in internal extensions (#12153) 
This type alias has now been fully documented for public consumption.

This will be beneficial to the sphinx ecosystem,
to aide/encourage extension developers to provide the correct metadata.

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
 2024-03-21 16:19:26 +01:00
Chris Sewell 3bedde26a9 🔧 Ruff format python files within docs folder (#12139) 
Remove `docs` files from the `exclude` list, and also add the `preview = false` format config, which is shown to reduce diffs to the current code base
 2024-03-19 15:23:57 +01:00
James AddisonandChris Sewell d93223a886 docs: add reference to templating from theme development. (#12056) 
Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>
 2024-03-19 14:43:42 +01:00
Bénédikt Tran b2069fb64f [lint] update Makefile and lint doc (#12117) 2024-03-17 14:45:56 +01:00
Dimitri Papadopoulos OrfanosAdam Turnerdanieleades
 		4f08cdff13 Enable the FURB113 rule in Ruff (#11856) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: danieleades <33452915+danieleades@users.noreply.github.com>
 2024-01-21 20:25:05 +00:00
Adam Turner 909f93c7ec Use `pyproject.toml entry points rather than setup.py` 2023-10-03 19:26:37 +01:00
Adam Turner 385a9193a7 Remove redundant labels 2023-10-02 13:10:26 +01:00
Adam Turner 9bcf1d8bb3 Fix TCH001 (move application import into a type-checking block) 2023-08-14 00:18:13 +01:00
Adam Turner 36012b7d96 Fix TCH002 (move third-party import into a type-checking block) 2023-08-13 22:50:03 +01:00
Adam Turner 1cfb68d8be Consistently name the object description options (#11533) 
*  The directive option ``:noindex:`` was renamed to ``:no-index:``.
*  The directive option ``:noindexentry:`` was renamed to ``:no-index-entry:``.
*  The directive option ``:nocontentsentry:`` was renamed to ``:no-contents-entry:``.

The previous names are retained as aliases, but will be deprecated
and removed in a future version of Sphinx (9.0 or later).
 2023-07-28 22:30:26 +01:00
Adam Turner 4be56f3b7d Remove deprecated `style` key for HTML templates (#11381) 2023-04-28 10:41:59 +01:00
James Addison 59de8d5202 Revert "Support and prefer `.jinja to _t` for static templates (#11165)" (#11329) 
This reverts commit 5d13215b58.
 2023-04-23 19:06:44 +01:00
James Addison 94f4afafa5 Add a missing word in `doc/development/theming.rst` (#11301) 2023-04-07 20:59:27 +01:00