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 Whetter
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
