diff options
Diffstat (limited to '')
| -rw-r--r-- | doc/support.rst | 29 |
1 files changed, 19 insertions, 10 deletions
diff --git a/doc/support.rst b/doc/support.rst index 0d349a0..69f800d 100644 --- a/doc/support.rst +++ b/doc/support.rst @@ -1,20 +1,29 @@ +.. _support-index: + Get support =========== -For questions or to report problems with Sphinx, join the `sphinx-users`_ -mailing list on Google Groups, come to the ``#sphinx-doc`` channel on -`libera.chat`_, or open an issue at the tracker_. +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 -.. _libera.chat: https://web.libera.chat/?channel=#sphinx-doc -.. _tracker: https://github.com/sphinx-doc/sphinx/issues +.. _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>`. -Examples of other projects using Sphinx can be found in the :doc:`examples page -<examples>`. A useful tutorial_ has been written by the matplotlib developers. +See also the guide by ReadTheDocs_ on how to get started with Sphinx. -.. _tutorial: https://matplotlib.sourceforge.net/sampledoc/ +.. _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. +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/ |