From fd859e1ee29d7a44b25d70af69ee4545b101b96a Mon Sep 17 00:00:00 2001 From: BO ZHANG Date: Sat, 16 Sep 2023 20:31:07 +0800 Subject: [PATCH] tweaks --- docs/source/api/csst_proto.rst | 2 +- docs/source/ch04_codestyle.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/api/csst_proto.rst b/docs/source/api/csst_proto.rst index c48cffe..2039436 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 6a2c202..6363bfb 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, -- GitLab