sphinx/doc/support.rst

.. _support-index:

Get support
===========

For questions or to report problems with Sphinx:

- Please verify that your question does not exist on StackOverflow_
  (with the tag ``python-sphinx``)
- open a topic at the `Github discussions`_ page,
- open an issue at the `Github issues`_ page,
- or join the `sphinx-users`_ mailing list on Google Groups,

.. _StackOverflow: https://stackoverflow.com/questions/tagged/python-sphinx
.. _sphinx-users: https://groups.google.com/group/sphinx-users
.. _Github discussions: https://github.com/sphinx-doc/sphinx/discussions
.. _Github issues: https://github.com/sphinx-doc/sphinx/issues

Examples of other projects using Sphinx can be found in the
:doc:`examples page <examples>`.

See also the guide by ReadTheDocs_ on how to get started with Sphinx.

.. _Readthedocs: https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html

There is a translation team in Transifex_ of this documentation,
thanks to the Sphinx document translators.

.. _Transifex: https://www.transifex.com/sphinx-doc/sphinx-doc/dashboard/
[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			`.. _support-index:`

Update documentation structure and theming (#10677) Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> 2022-07-18 16:48:28 -05:00			`Get support`
			`===========`

[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			`For questions or to report problems with Sphinx:`

			`- Please verify that your question does not exist on StackOverflow_`
			(with the tag ``python-sphinx``)
			- open a topic at the `Github discussions`_ page,
			- open an issue at the `Github issues`_ page,
			- or join the `sphinx-users`_ mailing list on Google Groups,
Update documentation structure and theming (#10677) Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> 2022-07-18 16:48:28 -05:00
[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			`.. _StackOverflow: https://stackoverflow.com/questions/tagged/python-sphinx`
Update documentation structure and theming (#10677) Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> 2022-07-18 16:48:28 -05:00			`.. _sphinx-users: https://groups.google.com/group/sphinx-users`
[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			`.. _Github discussions: https://github.com/sphinx-doc/sphinx/discussions`
			`.. _Github issues: https://github.com/sphinx-doc/sphinx/issues`

			`Examples of other projects using Sphinx can be found in the`
			:doc:`examples page <examples>`.
Update documentation structure and theming (#10677) Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> 2022-07-18 16:48:28 -05:00
[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			`See also the guide by ReadTheDocs_ on how to get started with Sphinx.`
Update documentation structure and theming (#10677) Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> 2022-07-18 16:48:28 -05:00
[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			`.. _Readthedocs: https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html`
Update documentation structure and theming (#10677) Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> 2022-07-18 16:48:28 -05:00
[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			`There is a translation team in Transifex_ of this documentation,`
			`thanks to the Sphinx document translators.`
Update documentation structure and theming (#10677) Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> 2022-07-18 16:48:28 -05:00
			`.. _Transifex: https://www.transifex.com/sphinx-doc/sphinx-doc/dashboard/`