Skip to content

Commit fc937a2

Browse files
authored
AbstractModelLibrary docs (#168)
2 parents ab747f9 + b66eb3f commit fc937a2

File tree

8 files changed

+619
-30
lines changed

8 files changed

+619
-30
lines changed

CHANGES.rst

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
- remove Windows tests and add info box indicating lack of Windows support to README [#163]
55
- add ``ModelLibrary`` container class [#156]
6+
- add ``ModelLibrary`` docs [#168]
67

78
0.6.1 (unreleased)
89
==================

docs/source/api.rst

+1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ stpipe API
44
.. automodapi:: stpipe
55

66
.. automodapi:: stpipe.library
7+
78
.. automodapi:: stpipe.datamodel

docs/source/conf.py

+3
Original file line numberDiff line numberDiff line change
@@ -55,5 +55,8 @@
5555
nitpicky = True
5656
nitpick_ignore = []
5757

58+
# Set the default role for all single backtick annotations
59+
default_role = "obj"
60+
5861
intersphinx_mapping = {}
5962
intersphinx_mapping["python"] = ("https://docs.python.org/3", None)

docs/source/index.rst

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Welcome to stpipe's documentation!
55
:maxdepth: 2
66
:caption: Contents:
77

8+
model_library.rst
9+
810
API
911
===
1012

0 commit comments

Comments
 (0)