Use autodoc to automatically generate documentation pages

documentation/source/conf.py

@@ -18,8 +18,8 @@
 # -- Project information -----------------------------------------------------
 
 project = 'MetaDrive'
-copyright = 'DrivingForce'
-author = 'DrivingForce'
+copyright = 'MetaDriverse'
+author = 'MetaDriverse'
 
 # The full version, including alpha/beta/rc tags
 release = '0.1.1'
@@ -31,9 +31,30 @@
 # ones.
 extensions = [
     "sphinx.ext.autosectionlabel",
-    "sphinx_rtd_theme"
+    "sphinx_rtd_theme",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.coverage",
+    "sphinx.ext.napoleon",
+    'sphinx.ext.autosummary',
 ]
 
+# See: https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html
+# Napoleon settings
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = True
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = False
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = False
+napoleon_use_param = True
+napoleon_use_rtype = True
+napoleon_preprocess_types = False
+napoleon_type_aliases = None
+napoleon_attr_annotations = True
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

documentation/source/docstring.rst

@@ -0,0 +1,7 @@
+Docstring
+============
+
+.. autosummary::
+   :toctree: generated
+
+   metadrive.scenario.utils

documentation/source/index.rst

@@ -65,6 +65,13 @@ Please feel free to contact us if you have any suggestions or ideas!
 
    known_issues.rst
 
+.. toctree::
+   :hidden:
+   :maxdepth: 2
+   :caption: Code Docs
+
+   docstring.rst
+
 
 .. raw:: html