[Docs] Add docstring to documentation generation with Sphinx Napoleon

.readthedocs.yaml

@@ -14,6 +14,9 @@ build:
     # nodejs: "19"
     # rust: "1.64"
     # golang: "1.19"
+  jobs:
+    pre_build:
+      - sphinx-apidoc -f -o docs/source/user_guide/reference/autogendocs mani_skill -d 2 
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
@@ -29,4 +32,10 @@ sphinx:
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 python:
    install:
-   - requirements: docs/requirements.txt
+     - requirements: docs/requirements.txt
+       method: pip
+       path: .
+       # Install packages required to build the documentation. 
+       # https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#module-sphinx.ext.autodoc 
+       extra_requirements:
+         - dev

docs/.gitignore

@@ -1 +1,2 @@
-build
+build
+source/user_guide/reference/autogendocs

docs/requirements.txt

@@ -13,3 +13,7 @@ sphinx-subfigure
 sphinxcontrib-video
 sphinx-togglebutton
 sphinx_design
+# For sphinx.ext.autodoc to correctly generate api documentation
+torch
+torchvision
+torchaudio

docs/source/conf.py

@@ -23,6 +23,7 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.mathjax",
     "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
     "sphinx_copybutton",
     "myst_parser",
     "sphinx_subfigure",
@@ -71,3 +72,6 @@
 
 autodoc_typehints = "description"
 autodoc_typehints_description_target = "all"
+
+# Other autodoc configurations
+autodoc_default_flags = ['members', 'show-inheritance', 'undoc-members']

docs/source/user_guide/reference/index.md

@@ -5,11 +5,6 @@ In the beta release we are still in the process of documenting all of the functi
 Subpackages:
 
 ```{toctree}
-:titlesonly:
-:maxdepth: 1
-
-mani_skill.envs.sapien_env
-
-mani_skill.utils.common
-mani_skill.utils.sapien_utils
+:maxdepth: 3
+autogendocs/mani_skill
 ```