Skip to content

DOC: Remove obsolete reference to CONTRIBUTING.md generation #45699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 30, 2022
+0 −10
Merged

DOC: Remove obsolete reference to CONTRIBUTING.md generation #45699

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions doc/source/development/contributing_documentation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://johnmacfarlane.net/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
Expand Down