docs: Adding the Python API to output docs.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
diff --git a/docs/conf.py b/docs/conf.py
index ac4865b..12d9e13 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -57,11 +57,13 @@
# 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',
]
diff --git a/docs/index.rst b/docs/index.rst
index fc257a5..954900a 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -9,6 +9,8 @@
contributing
+ Python API <python-api/index>
+
Welcome to SkyWater SKY130 PDK's documentation!
===============================================
diff --git a/docs/python-api b/docs/python-api
new file mode 120000
index 0000000..66d6680
--- /dev/null
+++ b/docs/python-api
@@ -0,0 +1 @@
+../scripts/python-skywater-pdk/docs/
\ No newline at end of file
diff --git a/scripts/python-skywater-pdk/docs/index.rst b/scripts/python-skywater-pdk/docs/index.rst
new file mode 100644
index 0000000..043d790
--- /dev/null
+++ b/scripts/python-skywater-pdk/docs/index.rst
@@ -0,0 +1,9 @@
+SkyWater PDK Python API
+=======================
+
+TODO: Add documentation here
+
+.. toctree::
+ :hidden:
+
+ skywater_pdk
diff --git a/scripts/python-skywater-pdk/docs/skywater_pdk.rst b/scripts/python-skywater-pdk/docs/skywater_pdk.rst
new file mode 100644
index 0000000..8488d1e
--- /dev/null
+++ b/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:
