Merge pull request #146 from opencobra/fix/docs

refactor: organize documentation build
opencobra · Aug 9, 2017 · efbb01a · efbb01a
2 parents a00958b + 10c572b
commit efbb01a
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -58,7 +58,7 @@
 
 # General information about the project.
 project = u'memote'
-copyright = u"2017, Moritz E. Beber"
+copyright = u"2017, Novo Nordisk Foundation Center for Biosustainability, # Technical University of Denmark"
 
 # The version info for the project you're documenting, acts as replacement
 # for |version| and |release|, also used in various other places throughout

diff --git a/docs/organization.rst b/docs/organization.rst
@@ -0,0 +1,19 @@
+====================
+Package Organization
+====================
+
+.. code-block::
+
+  memote - memote - support - ...
+                  - suite - tests - ...
+                          - reporting - ...
+         - tests - test_for_support
+
+* ``memote/support/``:
+  * Functions that perform checks on the model and return results.
+* ``memote/suite/tests/``:
+  * ``pytest`` functions that compare the output of ``memote/support/`` functions
+    with expected values.
+* ``tests/``:
+  * ``pytest`` functions that ensure that ``memote/support/`` functions perform
+    as expected.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,3 @@
+Sphinx
+numpydoc
+sphinx-bootstrap-theme