TODOs; Indices & Tables; Glossary; Ctoc

CDCgov · Mar 18, 2024 · a042977 · a042977
1 parent b37f9b4
commit a042977
Show file tree

Hide file tree

Showing 8 changed files with 49 additions and 8 deletions.
diff --git a/docs/source/_static/msei.css b/docs/source/_static/msei.css
@@ -0,0 +1,5 @@
+@import url('https://your-font-hosting-url.com/path/to/iosevka.css');
+
+body {
+    font-family: 'Iosevka', monospace;
+}
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -44,3 +44,4 @@
 
 html_theme = 'classic'
 html_static_path = ['_static']
+html_css_files = ['msei.css']
diff --git a/docs/source/ctoc.rst b/docs/source/ctoc.rst
@@ -0,0 +1,12 @@
+Complete Table Of Contents 
+==========================
+
+.. toctree::
+   :maxdepth: 4
+
+   msei_reference/index
+   test_reference/index
+   genindex
+   modindex
+   search
+   glossary
diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst
@@ -0,0 +1,12 @@
+Glossary 
+========
+
+.. glossary::
+
+   Term 1
+      Definition for term 1 etc...
+
+   Term 2
+      Definition for term 2 etc...
+
+..todo:: Populate the glossary with terms (e.g., from model_definition.md)
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -8,20 +8,27 @@ CFA Multisignal Renewal Documentation
 
 Welcome, CFA wishes you a nice day!
 
+
+Documentation Components
+========================
+
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+   :maxdepth: 1
 
    msei_reference/index
    test_reference/index
 
-
 Indices And Tables
 ==================
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+.. toctree::
+   :maxdepth: 1
+
+   genindex
+   modindex
+   search
+   glossary
+   ctoc
 
 Meta Information 
 ================

diff --git a/docs/source/msei_reference/basic.rst b/docs/source/msei_reference/basic.rst
@@ -4,4 +4,6 @@ Basic Renewal Model Module
 .. automodule:: pyrenew.basic
    :members:
    :undoc-members:
-   :show-inheritance:
+   :show-inheritance:
+
+..todo:: Describe `basic` in greater detail. 
diff --git a/docs/source/msei_reference/index.rst b/docs/source/msei_reference/index.rst
@@ -12,4 +12,6 @@ MSEI Reference
    basic
    transform
    process
-   math
+   math
+
+.. todolist::
diff --git a/model/src/test/__init__.py b/model/src/test/__init__.py