From c2bff5880edd71843cce7a3fc86993e7fcb63d13 Mon Sep 17 00:00:00 2001 From: Andras Deak Date: Sat, 29 Jan 2022 21:41:01 +0100 Subject: [PATCH] DOC: Remove obsolete reference to CONTRIBUTING.md generation --- doc/source/development/contributing_documentation.rst | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/doc/source/development/contributing_documentation.rst b/doc/source/development/contributing_documentation.rst index 39bc582511148..583eecf1ca8ab 100644 --- a/doc/source/development/contributing_documentation.rst +++ b/doc/source/development/contributing_documentation.rst @@ -89,16 +89,6 @@ Some other important things to know about the docs: ``doc/source/reference``, else Sphinx will emit a warning. -.. note:: - - The ``.rst`` files are used to automatically generate Markdown and HTML versions - of the docs. For this reason, please do not edit ``CONTRIBUTING.md`` directly, - but instead make any changes to ``doc/source/development/contributing.rst``. Then, to - generate ``CONTRIBUTING.md``, use `pandoc `_ - with the following command:: - - pandoc doc/source/development/contributing.rst -t markdown_github > CONTRIBUTING.md - The utility script ``scripts/validate_docstrings.py`` can be used to get a csv summary of the API documentation. And also validate common errors in the docstring of a specific class, function or method. The summary also compares the list of