add api reference to documentation using sphinx-autodoc2 (#115)

Author: joshuadavidthomas

src/django_twc_package/docs/conf.py.jinja

@@ -40,10 +40,10 @@ author = "{{ author_name }}"
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    "autodoc2",
     "myst_parser",
     "sphinx_copybutton",
     "sphinx_inline_tabs",
-    "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
 ]
 
@@ -59,10 +59,14 @@ exclude_patterns = []
 # -- MyST configuration ------------------------------------------------------
 myst_heading_anchors = 3
 
+# -- Options for autodoc2 -----------------------------------------------------
+autodoc2_packages = [f"../src/{project.replace('-', '_')}"]
+autodoc2_render_plugin = "myst"
+
+# -- Options for sphinx_copybutton -----------------------------------------------------
 copybutton_selector = "div.copy pre"
 copybutton_prompt_text = "$ "
 
-
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for

src/django_twc_package/docs/index.md renamed to src/django_twc_package/docs/index.md.jinja

@@ -2,6 +2,14 @@
 
 ```
 
+```{toctree}
+:hidden:
+:maxdepth: 3
+:caption: API Reference
+
+apidocs/{{ module_name }}/{{ module_name }}.rst
+```
+
 ```{toctree}
 :hidden:
 :maxdepth: 3

src/django_twc_package/pyproject.toml.jinja

@@ -60,6 +60,7 @@ docs = [
   "myst-parser",
   "sphinx",
   "sphinx-autobuild",
+  "sphinx-autodoc2",
   "sphinx-copybutton",
   "sphinx-inline-tabs"
 ]