sphinx/doc/development/index.rst

.. _extending-sphinx:

Extending Sphinx
================

This guide is aimed at giving a quick introduction for those wishing to
develop their own extensions for Sphinx.
Sphinx possesses significant extensibility capabilities
including the ability to hook into almost every point of the build process.
If you simply wish to use Sphinx with existing extensions,
refer to :doc:`/usage/index`.
For a more detailed discussion of the extension interface see :doc:`/extdev/index`.

.. toctree::
   :maxdepth: 2

   tutorials/index
   howtos/index
   html_themes/index
[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 13:12:57 -05:00			`.. _extending-sphinx:`

			`Extending Sphinx`
			`================`
docs: Add usage, development index page Signed-off-by: Stephen Finucane <stephen@that.guru> 2020-05-29 11:06:16 -05:00
Replace doclinter with sphinx-lint (#10389) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> 2022-06-16 13:32:09 -05:00			`This guide is aimed at giving a quick introduction for those wishing to`
[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 13:12:57 -05:00			`develop their own extensions for Sphinx.`
			`Sphinx possesses significant extensibility capabilities`
			`including the ability to hook into almost every point of the build process.`
			`If you simply wish to use Sphinx with existing extensions,`
			refer to :doc:`/usage/index`.
			For a more detailed discussion of the extension interface see :doc:`/extdev/index`.
docs: Add usage, development index page Signed-off-by: Stephen Finucane <stephen@that.guru> 2020-05-29 11:06:16 -05:00
			`.. toctree::`
			`:maxdepth: 2`

			`tutorials/index`
[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 13:12:57 -05:00			`howtos/index`
			`html_themes/index`