build docs main page using project rst files

csdms · Mar 31, 2021 · 91273af · 91273af
1 parent cb68626
commit 91273af
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 30 deletions.
diff --git a/docs/authors.rst b/docs/authors.rst
@@ -0,0 +1,2 @@
+.. include:: ../AUTHORS.rst
+
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -0,0 +1,2 @@
+.. include:: ../CHANGES.rst
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,55 +1,50 @@
-.. bmi_tester documentation master file, created by
-   sphinx-quickstart on Tue Jan  3 11:19:57 2017.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+.. image:: _static/bmi-tester-logo-text-lowercase.png
+    :align: center
+    :scale: 10%
+    :alt: Sequence
+    :target: https://sequence.readthedocs.org/
 
-Utilities for testing Python BMI implementaions
-===============================================
 
 The `bmi_tester` package provides command-line utilities for testing
 a Python classes that implement the Basic Model Interface (BMI).
 `bmi_tester` also provides a Python interface to the tester that allows
 users to run tests programmatically. The package is also easily
 extendable so that new tests can be added to the suite.
 
-Quickstart
-----------
 
-Install the ``bmi_tester`` package:
+Getting Started
+---------------
 
-.. code:: bash
+.. toctree::
+   :maxdepth: 3
 
-    $ conda install bmi_tester -c csdms-stack
+   readme
 
-This installs the `bmi_tester` package as well as the `bmi-tester`
-command. To get help, use the `-h` option:
+..   usage
+..   installation
 
-.. code:: bash
+API Reference
+-------------
 
-    $ bmi-tester -h
+If you are looking for information on a specific function, class, or
+method, this part of the documentation is for you.
 
-If the class you wish to test is installed (that is, you can run
-`from <something> import <class-to-test>`), you can use the
-`bmi-tester` command to test your implementation:
+.. toctree::
+   :maxdepth: 2
 
-.. code:: bash
+   api/index
 
-    $ bmi-tester something.class-to-test
 
+Miscellaneous Pages
+-------------------
 
-User Guide
-----------
 .. toctree::
-   :maxdepth: 1
-
-   bmi_tester
-
-References
-==========
+   :maxdepth: 2
 
-.. [BmiGitHub] BMI on GitHub
+   authors
+   changelog
+   license
 
-  https://github.com/csdms/bmi
 
 Indices and tables
 ==================

diff --git a/docs/license.rst b/docs/license.rst
@@ -0,0 +1,6 @@
+=======
+License
+=======
+
+.. include:: ../LICENSE.rst
+
diff --git a/docs/readme.rst b/docs/readme.rst
@@ -0,0 +1,2 @@
+.. include:: ../README.rst
+