From 80a4ae3340bc7eb6d7251dff61ff087b82c997f1 Mon Sep 17 00:00:00 2001
From: BO ZHANG <bozhang@nao.cas.cn>
Date: Fri, 7 Oct 2022 17:03:43 +0800
Subject: [PATCH] tweaks

---
 doc/source/api/csst_proto.rst |  1 +
 doc/source/codestyle.rst      | 37 +++++++++++++++++++++++++++++++----
 2 files changed, 34 insertions(+), 4 deletions(-)

diff --git a/doc/source/api/csst_proto.rst b/doc/source/api/csst_proto.rst
index 1e73d51..cdfced7 100644
--- a/doc/source/api/csst_proto.rst
+++ b/doc/source/api/csst_proto.rst
@@ -2,6 +2,7 @@ API
 ===
 
 .. automodule:: csst_proto.top_level_interface
+   :noindex:
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/doc/source/codestyle.rst b/doc/source/codestyle.rst
index b57903f..2a1326b 100644
--- a/doc/source/codestyle.rst
+++ b/doc/source/codestyle.rst
@@ -39,9 +39,23 @@ Files/directories with asterisks (*) marks are optional.
 Code Style
 ==========
 Python code should follow PEP 8
-    - https://peps.python.org/pep-0008/
+
+- https://peps.python.org/pep-0008/
+
 Whereas C/C++ code should follow PEP 7
-    - https://peps.python.org/pep-0007/
+
+- https://peps.python.org/pep-0007/
+
+Many IDEs (Pycharm, etc) and tools can be used to validate code style
+
+- pycodestyle:
+    - https://pycodestyle.pycqa.org/en/latest/
+
+In our case, we recommend the following method to check code style
+
+.. code-block:: bash
+
+    pycodestyle ./**/*.py --ignore=E121,E123,E126,E226,E24,E704,W503,W504,E501,E722
 
 
 Numpy-style docstring
@@ -50,9 +64,24 @@ There are several popular docstring styles, namely Google, reStructuredText, and
 The CSST DAS adopts Numpydoc-style among the three.
 We refer our developers to the Numpydoc official style guide for instructions on
 how to write docstrings.
-    - https://numpydoc.readthedocs.io/en/latest/format.html
+
+- https://numpydoc.readthedocs.io/en/latest/format.html
+
 In particular, a complete example is available here.
-    - https://numpydoc.readthedocs.io/en/latest/example.html
+
+- https://numpydoc.readthedocs.io/en/latest/example.html
+
+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}
+
+For example,
+
+.. code-block:: bash
+
+    python -m numpydoc --validate csst_proto.top_level_interface.flip_image
 
 
 Markup language
-- 
GitLab