update rsts

KissPeter · Mar 15, 2020 · aa729fb · aa729fb
1 parent 56c33b5
commit aa729fb
Show file tree

Hide file tree

Showing 9 changed files with 64 additions and 60 deletions.
diff --git a/docs/apifuzzer.base_template.rst b/docs/apifuzzer.base_template.rst
diff --git a/docs/apifuzzer.custom_fuzzers.rst b/docs/apifuzzer.custom_fuzzers.rst
diff --git a/docs/apifuzzer.fuzzer_target.rst b/docs/apifuzzer.fuzzer_target.rst
diff --git a/docs/apifuzzer.rst b/docs/apifuzzer.rst
@@ -4,20 +4,67 @@ apifuzzer package
 Submodules
 ----------
 
-.. toctree::
+apifuzzer.apifuzzer\_report module
+----------------------------------
+
+.. automodule:: apifuzzer.apifuzzer_report
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+apifuzzer.base\_template module
+-------------------------------
+
+.. automodule:: apifuzzer.base_template
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+apifuzzer.custom\_fuzzers module
+--------------------------------
+
+.. automodule:: apifuzzer.custom_fuzzers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+apifuzzer.server\_fuzzer module
+-------------------------------
+
+.. automodule:: apifuzzer.server_fuzzer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+apifuzzer.swagger\_template\_generator module
+---------------------------------------------
+
+.. automodule:: apifuzzer.swagger_template_generator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+apifuzzer.template\_generator\_base module
+------------------------------------------
+
+.. automodule:: apifuzzer.template_generator_base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+apifuzzer.utils module
+----------------------
+
+.. automodule:: apifuzzer.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
-   apifuzzer.base_template
-   apifuzzer.custom_fuzzers
-   apifuzzer.fuzzer_target
-   apifuzzer.server_fuzzer
-   apifuzzer.swagger_template_generator
-   apifuzzer.template_generator_base
-   apifuzzer.utils
 
 Module contents
 ---------------
 
 .. automodule:: apifuzzer
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/apifuzzer.server_fuzzer.rst b/docs/apifuzzer.server_fuzzer.rst
diff --git a/docs/apifuzzer.swagger_template_generator.rst b/docs/apifuzzer.swagger_template_generator.rst
diff --git a/docs/apifuzzer.template_generator_base.rst b/docs/apifuzzer.template_generator_base.rst
diff --git a/docs/apifuzzer.utils.rst b/docs/apifuzzer.utils.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -62,3 +62,9 @@ def __getitem__(cls, name):
     html_theme = 'sphinx_rtd_theme'
     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
     html_style = 'css/custom.css'
+
+"""
+Documentation update:
+- remove *.rst under docs except index.rst
+- run: sphinx-apidoc apifuzzer/ -o docs/
+"""