From 52d85f4110b11d9961c0bafc1a01acf34e18b6b9 Mon Sep 17 00:00:00 2001
From: Gavin Wiggins <6828967+wigging@users.noreply.github.com>
Date: Fri, 25 Oct 2024 11:55:15 -0400
Subject: [PATCH] Add autodoc extension and api reference page

---
 docs/api-reference.rst | 13 +++++++++++++
 docs/conf.py           |  2 +-
 docs/index.rst         |  1 +
 3 files changed, 15 insertions(+), 1 deletion(-)
 create mode 100644 docs/api-reference.rst

diff --git a/docs/api-reference.rst b/docs/api-reference.rst
new file mode 100644
index 00000000..4ad14b45
--- /dev/null
+++ b/docs/api-reference.rst
@@ -0,0 +1,13 @@
+API Reference
+=============
+
+Here.
+
+Core components
+---------------
+
+Here.
+
+.. error::
+
+   Can't import source code documentation with ``autodoc`` because flowcept requires a running database just to import the package. This needs be fixed before any API documentation can be generated by Sphinx. See `issue 144 <https://github.com/ORNL/flowcept/issues/144>`_ on GitHub repository for more information.
diff --git a/docs/conf.py b/docs/conf.py
index 5a555153..5c1558d3 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -13,7 +13,7 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = []
+extensions = ["sphinx.ext.autodoc"]
 
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
diff --git a/docs/index.rst b/docs/index.rst
index 73e22fa6..9abed32b 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -17,3 +17,4 @@ documentation for details.
 
    getstarted
    contributing
+   api-reference