IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
21,033 Commits 2 Branches 219 Tags 163 MiB
dd77f85149
Commit Graph

95 Commits

Author SHA1 Message Date
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 Geier
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 Addison
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 Sewell
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 Addison
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 Orfanos
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
James Addison
5d13215b58
Support and prefer `.jinja to _t` for static templates (#11165) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2023-04-07 18:07:15 +01:00
Adam Turner
7ecf037280 Enable 'nit-picky mode' for Sphinx's documentation 
Fix several reference errors throughout the documentation and set
``nitpick_ignore`` in ``doc/conf.py``.
 2023-04-06 23:11:39 +01:00
Adam Turner
c8f4a03dac Fix COM812 2023-02-18 01:58:05 +00:00
Adam Turner
670bcb743b
Documentation reshuffle (#11112) 2023-01-08 13:52:36 +00:00
Adam Turner
4032070e81
Run pyupgrade (#11070) 2023-01-02 00:01:14 +00:00
Adam Turner
14a9289d78 Use PEP 604 types 2023-01-01 20:48:39 +00:00
Adam Turner
f4c8a0a68e Insert `from __future__ import annotations` 2023-01-01 20:48:37 +00:00
mikemckiernan
32bce8fb7c
Copy edit the tutorial (#11049) 
- Correct two typos.
- Include the ingredient index in the "for example"
  statement. It's tedious, but the audience is reading
  to learn.
 2022-12-29 13:58:32 +00:00
Martin Liška
9844162473
Fix example using `add_config_value` (#10937) 
``add_config_value()`` has mandatory 3 arguments.
 2022-12-20 13:15:00 +00:00
Adam Turner
920828fe35 Run the `pyupgrade` tool 2022-10-17 22:39:09 +01:00
danieleades
276f430b57
Begin addding flake8-simplify checks (#10820) 
Start with SIM104 and ignore all other flake8-simplify warnings
 2022-09-20 21:30:31 +01:00
Adam Turner
7ef46150d1
Update doc/development/tutorials/helloworld.rst 2022-08-07 10:16:39 +01:00
David Stansby
26ca57893d
Fix small typo in extension hello world tutorial 2022-08-04 16:48:24 +01:00
daniel.eades
964fcb2e07 Fix flake8 5.0.0 reported formatting errors 2022-08-01 20:55:47 +02:00
Takeshi KOMIYA
e7fc03bce2
Allow specifying multiple CSS files in themes (#10465) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2022-07-17 12:27:43 +01:00
Julien Palard
956cddb7d4
Replace doclinter with sphinx-lint (#10389) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-06-16 19:32:09 +01:00
Takeshi KOMIYA
e6f07c7381
doc: Fix syntax error 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-05-22 13:34:21 +09:00
Takeshi KOMIYA
c63d4741e9 Fix #10344: docs: Update explanation for copying static files manually 2022-05-15 23:38:01 +09:00
Takeshi KOMIYA
e4f78df2fc
Merge pull request #10345 from Thecarisma/fix-theming-add-static-file-documentation 
Refractor the example in 'Add your own static files to the build assets' documentation section
 2022-05-03 02:10:57 +09:00
Adam Turner
35ed39c946 Use Node.findall 2022-04-22 04:21:39 +01:00
Adam Turner
cbe0c99181 rawsource is deprecated in docutils.nodes.Text 2022-04-22 04:21:38 +01:00
Adewale Azeez
02074f8ed4
Fix the example in 'Add your own static files to the build assets' documentation section 2022-04-14 01:52:37 +01:00
Daniel Townsend
bcb0a03f92
setup -> set up 2022-02-10 17:44:18 +00:00
Daniel Townsend
03c8ceb85f
improve grammar in theming.rst 2022-02-08 13:05:18 +00:00