summaryrefslogtreecommitdiffstats
path: root/doc/support.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-09-19 04:57:07 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-09-19 04:57:07 +0000
commit46fc0a4b3dccce58c429f408c04cf5cda3af9fb5 (patch)
tree410d83c434319e0c6f8035cdfa60ae8957b1d909 /doc/support.rst
parentAdding upstream version 7.3.7. (diff)
downloadsphinx-upstream.tar.xz
sphinx-upstream.zip
Adding upstream version 7.4.7.upstream/7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--doc/support.rst29
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/