diff --git a/docs/source/_static/msei.css b/docs/source/_static/msei.css new file mode 100644 index 00000000..84a87f06 --- /dev/null +++ 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; +} \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 15d200e4..90cba29c 100644 --- 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'] \ No newline at end of file diff --git a/docs/source/ctoc.rst b/docs/source/ctoc.rst new file mode 100644 index 00000000..a801dec9 --- /dev/null +++ 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 \ No newline at end of file diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst new file mode 100644 index 00000000..f93ffaf3 --- /dev/null +++ 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) \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index e09ae0a2..3ceb1835 100644 --- 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 index 56039a72..b4cbefc1 100644 --- 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: \ No newline at end of file + :show-inheritance: + +..todo:: Describe `basic` in greater detail. \ No newline at end of file diff --git a/docs/source/msei_reference/index.rst b/docs/source/msei_reference/index.rst index 558eae66..5ae83696 100644 --- a/docs/source/msei_reference/index.rst +++ b/docs/source/msei_reference/index.rst @@ -12,4 +12,6 @@ MSEI Reference basic transform process - math \ No newline at end of file + math + +.. todolist:: \ No newline at end of file diff --git a/model/src/test/__init__.py b/model/src/test/__init__.py new file mode 100644 index 00000000..e69de29b