File tree Expand file tree Collapse file tree 1 file changed +0
-10
lines changed Expand file tree Collapse file tree 1 file changed +0
-10
lines changed Original file line number Diff line number Diff 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-
10292The utility script ``scripts/validate_docstrings.py `` can be used to get a csv
10393summary of the API documentation. And also validate common errors in the docstring
10494of a specific class, function or method. The summary also compares the list of
You can’t perform that action at this time.
0 commit comments