diff --git a/docs/source/api/csst_proto.rst b/docs/source/api/csst_proto.rst index c48cffe04116f8f73c18fb402cc2cfc8370f76d4..2039436bc9a36a6fe00e3d8c459f9b20117db83b 100644 --- a/docs/source/api/csst_proto.rst +++ b/docs/source/api/csst_proto.rst @@ -4,7 +4,7 @@ API In this chapter, we show what the rendered Numpy-style docstring looks like in sphinx documentation. -.. automodule:: csst_proto.top_level_interface +.. automodule:: csst_proto.api :noindex: :members: :undoc-members: diff --git a/docs/source/ch04_codestyle.rst b/docs/source/ch04_codestyle.rst index 6a2c2023cebc819eee81ab83284eb652dc15bb2d..6363bfb3a6f167319bd5da11dfb9e376c256a4d9 100644 --- a/docs/source/ch04_codestyle.rst +++ b/docs/source/ch04_codestyle.rst @@ -96,7 +96,7 @@ In our case, we recommend the following method to check docstring .. code-block:: bash - python -m numpydoc --validate {YOUR_PACKAGE}.top_level_interface.{YOUR_FUNCTION/CLASS} + python -m numpydoc --validate {YOUR_PACKAGE}.api.{YOUR_FUNCTION/CLASS} For example,