33 Commits
Author SHA1 Message Date
Ronald Eddy Jr 9db1715c18 Add an example for the `envvar` directive (#14295) 2026-10-22 17:19:51 -07:00
Tamika Nomara e92900948e Update list of maintained third-party domains (#13919) 2025-10-05 03:13:09 +01:00
Adam Turner 5221bfccd4 Refresh the list of third-party domains (#13691) 2025-06-24 01:20:48 +01:00
Adam Turner 774f8cc738 Add the new `py:deco` cross-reference role (#13292) 2025-02-03 01:07:38 +00:00
Adam Turner 5667050dd2 Improve the displayed signature for abstract methods (#13271) 2025-01-29 02:34:46 +00:00
Adam Turner 7801540c08 Support `:no-index-entry: in .. {js,py}:module::` (#13272) 2025-01-28 01:33:28 +00:00
Adam Turner 44891a4eef Update the 'Python Signatures' section 2025-01-26 04:54:34 +00:00
Adam Turner a1c77f1725 Improve wording for the `:type:`directive option warning (#13256) 2025-01-23 14:11:57 +00:00
Adam Turner e18155fa10 Note when `.. confval::` was added 2025-01-21 08:08:29 +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
Tim HoffmannandAdam Turner 4080be1e82 Improve cross-reference documentation (#12944)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-10-03 15:58:37 +01:00
Tim HoffmannandAdam Turner b16e196a60 Improve `autodoc` docs (#12935)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-10-02 23:02:48 +00: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 26576590ed Make the domain referencing role targets more specific 2024-07-15 01:59:42 +01:00
Ashley WhetterandAdam Turner e38a60d3f2 Add `py:type` directive and role for documenting type aliases (#11989)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-07-11 12:15:54 +01:00
Adam Turner a4de250b5a Add a new `confval` directive to document settings and configuration values (#12536) 2024-07-10 20:44:16 +01: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
Bénédikt Tran b2069fb64f [lint] update Makefile and lint doc (#12117) 2024-03-17 14:45:56 +01:00
Dimitri Papadopoulos Orfanos 460a63010f Fix various spelling errors (#11735) 2024-01-04 02:37:44 +00:00
Adam Turner 5d58624227 Reformat the domains lists 2023-10-02 13:10:26 +01:00
Adam Turner f7f41e6828 Fix and standardise markup 2023-10-02 13:10:26 +01:00
Adam Turner 3dd10e47d0 Add versionadded directives 2023-10-02 13:10:26 +01:00
Adam Turner e15fc04e53 Promote underline levels 2023-10-02 13:10:26 +01:00
Adam Turner 385a9193a7 Remove redundant labels 2023-10-02 13:10:26 +01:00
Adam Turner 607aadc660 Split out the Maths domain 2023-10-02 13:10:26 +01:00
Adam Turner c6dd47d2c8 Split out the reStructuredText domain 2023-10-02 13:10:26 +01:00
Adam Turner f6bafc7dad Split out the JavaScript domain 2023-10-02 13:10:25 +01:00
Adam Turner c8b2191059 Split out the Standard domain 2023-10-02 13:10:12 +01:00
Adam Turner de3266ab25 Split out the C++ domain 2023-10-02 13:10:12 +01:00
Adam Turner db6cc67f1a Split out the C domain 2023-10-02 13:10:12 +01:00
Adam Turner d491d3e04c Split out the Python domain 2023-10-02 13:10:12 +01:00
Adam Turner c0e17eca40 Move the domains reference up one level 2023-10-02 13:09:38 +01:00