docs: Adding the Python API to output docs.

Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>

docs/conf.py

@@ -57,11 +57,13 @@ release = ''
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.todo',
-    'sphinx.ext.mathjax',
-    'sphinx.ext.ifconfig',
-    'sphinx.ext.githubpages',
+    'sphinx.ext.autodoc',
     'sphinx.ext.autosectionlabel',
+    'sphinx.ext.githubpages',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.todo',
     'sphinxcontrib_verilog_diagrams',
 ]
 

docs/index.rst

@@ -9,6 +9,8 @@
 
     contributing
 
+    Python API <python-api/index>
+
 
 Welcome to SkyWater SKY130 PDK's documentation!
 ===============================================

docs/python-api

@@ -0,0 +1 @@
+../scripts/python-skywater-pdk/docs/

scripts/python-skywater-pdk/docs/index.rst

@@ -0,0 +1,9 @@
+SkyWater PDK Python API
+=======================
+
+TODO: Add documentation here
+
+.. toctree::
+    :hidden:
+
+    skywater_pdk

scripts/python-skywater-pdk/docs/skywater_pdk.rst

@@ -0,0 +1,38 @@
+skywater\_pdk package
+=====================
+
+Submodules
+----------
+
+skywater\_pdk.base module
+-------------------------
+
+.. automodule:: skywater_pdk.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+skywater\_pdk.sizes module
+---------------------------
+
+.. automodule:: skywater_pdk.sizes
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+skywater\_pdk.utils module
+--------------------------
+
+.. automodule:: skywater_pdk.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: skywater_pdk
+   :members:
+   :undoc-members:
+   :show-inheritance: