Generate rst files during build time

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>

.github/workflows/apidoc.yml

@@ -33,6 +33,7 @@ jobs:
 
     - name: Build documentation
       run: |
+        sphinx-apidoc -o docs/ ntia_conformance_checker/
         cd docs
         make html
 

docs/conf.py

@@ -15,13 +15,21 @@
 # Path setup
 sys.path.insert(0, os.path.abspath(".."))
 
-# -- Project information -----------------------------------------------------
+# Add any paths that contain templates here, relative to this directory.
+templates_path: list[str] = ["_templates"]
 
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+# Project information
 project = "NTIA Conformance Checker"  # pylint: disable=C0103
 project_copyright = "2022-%Y SPDX contributors"  # pylint: disable=C0103
 author = "SPDX contributors"  # pylint: disable=C0103
 
-# -- General configuration ---------------------------------------------------
+# The theme to use for HTML and HTML Help pages.
+html_theme = "sphinx_rtd_theme"  # pylint: disable=C0103
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -32,21 +40,7 @@
     "sphinx.ext.viewcode",
 ]
 
-# Add any paths that contain templates here, relative to this directory.
-templates_path: list[str] = ["_templates"]
-
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns: list[str] = []
-
-# -- Options for HTML output -------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.
-# See the documentation for a list of builtin themes.
-html_theme = "sphinx_rtd_theme"  # pylint: disable=C0103
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]

docs/index.rst

@@ -1,6 +1,8 @@
 .. NTIA Conformance Checker documentation master file.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
+   The `modules` item will be generated from this command line:
+   sphinx-apidoc -o docs/ ntia_conformance_checker/
 
 NTIA Conformance Checker's documentation
 ====================================================