Skip to content

Commit c44b561

Browse files
authored
DOC: Remove obsolete reference to CONTRIBUTING.md generation (#45699)
1 parent 237260d commit c44b561

File tree

1 file changed

+0
-10
lines changed

1 file changed

+0
-10
lines changed

doc/source/development/contributing_documentation.rst

-10
Original file line numberDiff line numberDiff line change
@@ -89,16 +89,6 @@ Some other important things to know about the docs:
8989
``doc/source/reference``, else Sphinx
9090
will emit a warning.
9191

92-
.. note::
93-
94-
The ``.rst`` files are used to automatically generate Markdown and HTML versions
95-
of the docs. For this reason, please do not edit ``CONTRIBUTING.md`` directly,
96-
but instead make any changes to ``doc/source/development/contributing.rst``. Then, to
97-
generate ``CONTRIBUTING.md``, use `pandoc <https://johnmacfarlane.net/pandoc/>`_
98-
with the following command::
99-
100-
pandoc doc/source/development/contributing.rst -t markdown_github > CONTRIBUTING.md
101-
10292
The utility script ``scripts/validate_docstrings.py`` can be used to get a csv
10393
summary of the API documentation. And also validate common errors in the docstring
10494
of a specific class, function or method. The summary also compares the list of

0 commit comments

Comments
 (0)