Merge 8aeab60 into 3162e32

.gitignore

@@ -75,7 +75,6 @@ coverage.xml
 
 # Sphinx documentation
 docs/_build/
-docs/auto_config.rst
 
 # PyBuilder
 target/

Makefile

@@ -69,7 +69,7 @@ coverage-html: coverage ## check code coverage quickly with the default Python
 docs: ## generate Sphinx HTML documentation, including API docs
 	rm -f docs/awsm.rst
 	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/ awsm
+	sphinx-apidoc -o docs/api awsm
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 	$(BROWSER) docs/_build/html/index.html

docs/_templates/footer.html

@@ -0,0 +1,9 @@
+{% extends "!footer.html" %}
+
+{% block extrafooter %}
+	<div class="footer">
+        <!-- your html code here -->
+        <br>
+        <img style="width: 200px; margin-left: auto; margin-right: auto; display: block;" src="{{ pathto("_static/ars_logo.png", 1) }}" alt="ARS logo" />
+    </div>
+{% endblock %}

docs/_templates/layout.html

@@ -0,0 +1,13 @@
+{% extends "!layout.html" %}
+
+{% block header %}
+<!-- <img src="{{ pathto("_static/ars_logo.png", 1) }}" alt="ARS logo" />-->
+{% endblock %}
+
+{% block extrafooter %}
+<div class="footer">
+    <!-- your html code here
+        Hello!
+        layout.html-->
+</div>
+{% endblock %}

docs/api/awsm.framework.rst

@@ -0,0 +1,29 @@
+awsm.framework package
+======================
+
+Submodules
+----------
+
+awsm.framework.ascii\_art module
+--------------------------------
+
+.. automodule:: awsm.framework.ascii_art
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+awsm.framework.framework module
+-------------------------------
+
+.. automodule:: awsm.framework.framework
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: awsm.framework
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/awsm.interface.rst

@@ -0,0 +1,21 @@
+awsm.interface package
+======================
+
+Submodules
+----------
+
+awsm.interface.ingest\_data module
+----------------------------------
+
+.. automodule:: awsm.interface.ingest_data
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: awsm.interface
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/awsm.models.pysnobal.rst

@@ -0,0 +1,37 @@
+awsm.models.pysnobal package
+============================
+
+Submodules
+----------
+
+awsm.models.pysnobal.init\_model module
+---------------------------------------
+
+.. automodule:: awsm.models.pysnobal.init_model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+awsm.models.pysnobal.ipysnobal module
+-------------------------------------
+
+.. automodule:: awsm.models.pysnobal.ipysnobal
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+awsm.models.pysnobal.pysnobal\_io module
+----------------------------------------
+
+.. automodule:: awsm.models.pysnobal.pysnobal_io
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: awsm.models.pysnobal
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/awsm.models.rst

@@ -0,0 +1,29 @@
+awsm.models package
+===================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   awsm.models.pysnobal
+
+Submodules
+----------
+
+awsm.models.smrf\_connector module
+----------------------------------
+
+.. automodule:: awsm.models.smrf_connector
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: awsm.models
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/awsm.rst

@@ -0,0 +1,21 @@
+awsm package
+============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   awsm.framework
+   awsm.interface
+   awsm.models
+   awsm.tests
+
+Module contents
+---------------
+
+.. automodule:: awsm
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/awsm.tests.output.rst

@@ -0,0 +1,21 @@
+awsm.tests.output package
+=========================
+
+Submodules
+----------
+
+awsm.tests.output.test\_file\_output module
+-------------------------------------------
+
+.. automodule:: awsm.tests.output.test_file_output
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: awsm.tests.output
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/awsm.tests.restart.rst

@@ -0,0 +1,29 @@
+awsm.tests.restart package
+==========================
+
+Submodules
+----------
+
+awsm.tests.restart.test\_lakes module
+-------------------------------------
+
+.. automodule:: awsm.tests.restart.test_lakes
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+awsm.tests.restart.test\_rme module
+-----------------------------------
+
+.. automodule:: awsm.tests.restart.test_rme
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: awsm.tests.restart
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/awsm.tests.rst

@@ -0,0 +1,86 @@
+awsm.tests package
+==================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   awsm.tests.output
+   awsm.tests.restart
+
+Submodules
+----------
+
+awsm.tests.awsm\_test\_case module
+----------------------------------
+
+.. automodule:: awsm.tests.awsm_test_case
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+awsm.tests.awsm\_test\_case\_lakes module
+-----------------------------------------
+
+.. automodule:: awsm.tests.awsm_test_case_lakes
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+awsm.tests.check\_mixin module
+------------------------------
+
+.. automodule:: awsm.tests.check_mixin
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+awsm.tests.test\_awsm\_directory module
+---------------------------------------
+
+.. automodule:: awsm.tests.test_awsm_directory
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+awsm.tests.test\_awsm\_lakes module
+-----------------------------------
+
+.. automodule:: awsm.tests.test_awsm_lakes
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+awsm.tests.test\_awsm\_lakes\_init module
+-----------------------------------------
+
+.. automodule:: awsm.tests.test_awsm_lakes_init
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+awsm.tests.test\_awsm\_lakes\_lidar\_update module
+--------------------------------------------------
+
+.. automodule:: awsm.tests.test_awsm_lakes_lidar_update
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+awsm.tests.test\_awsm\_rme module
+---------------------------------
+
+.. automodule:: awsm.tests.test_awsm_rme
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: awsm.tests
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api.rst → docs/api/index.rst

@@ -8,4 +8,8 @@ The API here describes all the classes and functions
 used in AWSM.
 
 
-.. include:: modules.rst
+.. toctree::
+
+    awsm.framework
+    awsm.interface
+    awsm.models

docs/api/modules.rst

@@ -0,0 +1,7 @@
+awsm
+====
+
+.. toctree::
+   :maxdepth: 4
+
+   awsm