Add autodoc extension and api reference page

ORNL · Nov 1, 2024 · 2ff8845 · 2ff8845
1 parent 4ba23e8
commit 2ff8845
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git a/docs/api-reference.rst 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
@@ -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
@@ -17,3 +17,4 @@ documentation for details.
 
    getstarted
    contributing
+   api-reference
Original file line number	Diff line number	Diff line change
Expand Up		@@ -17,3 +17,4 @@ documentation for details.

		getstarted
		contributing
		api-reference