diff --git a/docs/contributing/documentation.rst b/docs/contributing/documentation.rst deleted file mode 100644 index 1cb68e576..000000000 --- a/docs/contributing/documentation.rst +++ /dev/null @@ -1,36 +0,0 @@ -.. SPDX-FileCopyrightText: 2023 The meson-python developers -.. -.. SPDX-License-Identifier: MIT - -.. _contributing-documentation: - -************* -Documentation -************* - -Our documentation is built on sphinx_, is written using reStructuredText_, and -follows the Diátaxis_ framework. - -To automatically re-build the documentation and serve it on an web server, you -can pass the ``serve`` argument to the ``docs`` nox_ task. - - -.. code-block:: console - - $ nox -s docs -- serve - - -When using this argument, the task will watch the documentation source files, -and every time you edit something, it will automatically re-build the -documentation and make it available on the provided web server. - - -.. todo:: - - Elaborate more with tips on how to write. - - -.. _sphinx: https://www.sphinx-doc.org -.. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html -.. _Diátaxis: https://diataxis.fr/ -.. _nox: https://github.com/wntrblm/nox diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst index 0f16f772e..71ba383e0 100644 --- a/docs/contributing/index.rst +++ b/docs/contributing/index.rst @@ -8,5 +8,4 @@ Development .. toctree:: - documentation release-process