Skip to content

Commit 8e8b2e5

Browse files
ArunimSamudraWillAyd
authored andcommitted
Fixes non-existent doc/source/api.rst issue (#31280)
1 parent e7b6a25 commit 8e8b2e5

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

doc/source/development/contributing.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,7 @@ Some other important things to know about the docs:
410410
doc build. This approach means that code examples will always be up to date,
411411
but it does make the doc building a bit more complex.
412412

413-
* Our API documentation in ``doc/source/api.rst`` houses the auto-generated
413+
* Our API documentation files in ``doc/source/reference`` house the auto-generated
414414
documentation from the docstrings. For classes, there are a few subtleties
415415
around controlling which methods and attributes have pages auto-generated.
416416

@@ -428,7 +428,8 @@ Some other important things to know about the docs:
428428
``Methods`` section in the class docstring. See ``CategoricalIndex`` for an
429429
example.
430430

431-
Every method should be included in a ``toctree`` in ``api.rst``, else Sphinx
431+
Every method should be included in a ``toctree`` in one of the documentation files in
432+
``doc/source/reference``, else Sphinx
432433
will emit a warning.
433434

434435
.. note::
@@ -444,11 +445,11 @@ Some other important things to know about the docs:
444445
The utility script ``scripts/validate_docstrings.py`` can be used to get a csv
445446
summary of the API documentation. And also validate common errors in the docstring
446447
of a specific class, function or method. The summary also compares the list of
447-
methods documented in ``doc/source/api.rst`` (which is used to generate
448+
methods documented in the files in ``doc/source/reference`` (which is used to generate
448449
the `API Reference <https://pandas.pydata.org/pandas-docs/stable/api.html>`_ page)
449450
and the actual public methods.
450-
This will identify methods documented in ``doc/source/api.rst`` that are not actually
451-
class methods, and existing methods that are not documented in ``doc/source/api.rst``.
451+
This will identify methods documented in ``doc/source/reference`` that are not actually
452+
class methods, and existing methods that are not documented in ``doc/source/reference``.
452453

453454

454455
Updating a *pandas* docstring

0 commit comments

Comments
 (0)