Minor fixes to docs

Metron-Project · Aug 15, 2023 · b00887b · b00887b
1 parent bccc2c1
commit b00887b
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 9 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -5,16 +5,13 @@
 # Required
 version: 2
 
-build:
-  os: ubuntu-20.04
-  tools:
-    python: "3.9"
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
 
+# Optionally set the version of Python and requirements required to build your docs
 python:
+  version: "3.9"
   install:
     - method: pip
       path: .
-
-# Build documentation in the docs/ directory with Sphinx
-sphinx:
-  configuration: docs/source/conf.py
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -15,6 +15,9 @@
 
 sys.path.insert(0, os.path.abspath("../.."))  # noqa: PTH100
 
+# This import needs to be *after* setting the sys path
+import darkseid  # noqa: E402, I001
+
 
 # -- Project information -----------------------------------------------------
 
@@ -23,7 +26,7 @@
 author = "Brian Pepple"
 
 # The full version, including alpha/beta/rc tags
-release = "3.0.0"
+version = release = darkseid.__version__
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,6 +6,11 @@
 Welcome to Darkseid's documentation!
 ====================================
 
+Release v\ |version|.
+
+API Reference
+=============
+
 .. toctree::
    :maxdepth: 2