Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #93

Open
wants to merge 29 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 28 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
2992939
moving to the pandas rtd theme, simple layout for now
Feb 10, 2021
af904c4
updating the read the docs yml
Feb 12, 2021
57cbcd2
mocking awsm and pysnobal
Feb 12, 2021
a330a01
updating mock
Feb 12, 2021
565025b
mock more?
Feb 12, 2021
928e6fe
add some deps to the docs that are needed before pysnobal can be inst…
Feb 12, 2021
a405ecf
added folder structure to dev stack
May 6, 2021
72c3c6e
updated full stack docs
May 6, 2021
67115d6
page placeholders for getting started, awsm basin setup filled out
May 7, 2021
81cd29d
getting started
May 28, 2021
420ef1a
Merge branch 'main' into dev_docs
May 28, 2021
0417bd3
getting started docs
May 28, 2021
d789117
install doc structure
Jun 1, 2021
935d482
getting started docs
Jun 9, 2021
24c43ca
tk < 0 doc
Jun 9, 2021
d4b7703
user guide for configuration files, added the smrf config file as well
Jun 9, 2021
b709b20
debugging docs
Jun 10, 2021
964d201
input data user guide
Jun 10, 2021
78aecc5
laying out the advanced topo guide
Jun 10, 2021
9389862
docs requirements
Jun 11, 2021
f715c94
Merge branch 'main' into dev_docs
Jun 11, 2021
7d29eab
Added info to basin_setup description
Jun 16, 2021
c5e0974
Merge pull request #92 from USDA-ARS-NWRC/Hedrick-ARS-patch-1
Jul 21, 2021
324058a
refs
Jul 22, 2021
94f1056
Merge branch 'dev_docs' of github.com:USDA-ARS-NWRC/awsm into dev_docs
Jul 22, 2021
1a19e4b
updated basin setup docs
Jul 22, 2021
589d260
awsm api docs
Jul 22, 2021
8aeab60
cleaning up unused doc files
Jul 22, 2021
0530a7c
clarify basin setup
Aug 9, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ coverage.xml

# Sphinx documentation
docs/_build/
docs/auto_config.rst

# PyBuilder
target/
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 9 additions & 0 deletions docs/_templates/footer.html
Original file line number Diff line number Diff line change
@@ -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 %}
13 changes: 13 additions & 0 deletions docs/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -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 %}
29 changes: 29 additions & 0 deletions docs/api/awsm.framework.rst
Original file line number Diff line number Diff line change
@@ -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:
21 changes: 21 additions & 0 deletions docs/api/awsm.interface.rst
Original file line number Diff line number Diff line change
@@ -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:
37 changes: 37 additions & 0 deletions docs/api/awsm.models.pysnobal.rst
Original file line number Diff line number Diff line change
@@ -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:
29 changes: 29 additions & 0 deletions docs/api/awsm.models.rst
Original file line number Diff line number Diff line change
@@ -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:
21 changes: 21 additions & 0 deletions docs/api/awsm.rst
Original file line number Diff line number Diff line change
@@ -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:
21 changes: 21 additions & 0 deletions docs/api/awsm.tests.output.rst
Original file line number Diff line number Diff line change
@@ -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:
29 changes: 29 additions & 0 deletions docs/api/awsm.tests.restart.rst
Original file line number Diff line number Diff line change
@@ -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:
86 changes: 86 additions & 0 deletions docs/api/awsm.tests.rst
Original file line number Diff line number Diff line change
@@ -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:
6 changes: 5 additions & 1 deletion docs/api.rst → docs/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
7 changes: 7 additions & 0 deletions docs/api/modules.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
awsm
====

.. toctree::
:maxdepth: 4

awsm
1 change: 0 additions & 1 deletion docs/authors.rst

This file was deleted.

Loading