AbstractModelLibrary docs (#168)

spacetelescope · Jul 31, 2024 · fc937a2 · fc937a2
2 parents ab747f9 + b66eb3f
commit fc937a2
Show file tree

Hide file tree

Showing 8 changed files with 619 additions and 30 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -3,6 +3,7 @@
 
 - remove Windows tests and add info box indicating lack of Windows support to README [#163]
 - add ``ModelLibrary`` container class [#156]
+- add ``ModelLibrary`` docs [#168]
 
 0.6.1 (unreleased)
 ==================

diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -4,4 +4,5 @@ stpipe API
 .. automodapi:: stpipe
 
 .. automodapi:: stpipe.library
+
 .. automodapi:: stpipe.datamodel
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -55,5 +55,8 @@
 nitpicky = True
 nitpick_ignore = []
 
+# Set the default role for all single backtick annotations
+default_role = "obj"
+
 intersphinx_mapping = {}
 intersphinx_mapping["python"] = ("https://docs.python.org/3", None)
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -5,6 +5,8 @@ Welcome to stpipe's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   model_library.rst
+
 API
 ===
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,4 +4,5 @@ stpipe API
		.. automodapi:: stpipe

		.. automodapi:: stpipe.library

		.. automodapi:: stpipe.datamodel
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,6 +5,8 @@ Welcome to stpipe's documentation! @@
        :maxdepth: 2
        :caption: Contents:
+       model_library.rst
     API
     ===
@@ Expand Down @@