Documentation updates following MARBL meeting

I also updated the python environment that RTD will use to build the documentation (using the latest version of the RTD default theme, etc).
klindsay28 · Jun 6, 2018 · 85e672a · 85e672a
1 parent db09f40
commit 85e672a
Show file tree

Hide file tree

Showing 7 changed files with 82 additions and 104 deletions.
diff --git a/INSTALL b/INSTALL
@@ -0,0 +1,31 @@
+---------------------------------------------
+| INSTALLING THE LIBRARY FOR EXTERNAL USAGE |
+---------------------------------------------
+
+The Makefile in src/ provides all that is needed to build the library. For
+testing purposes, you can run
+
+$ make [gnu|intel|pgi|nag|cray]
+
+to build with a specific compiler using pre-set compiler flags. However, if
+you want to build MARBL to link with an outside program, you may want more
+control over the compile-time options. To that end, run
+
+$ make OBJ_DIR=[location of object files] depends
+$ make [desired_location_of_lib]/libmarbl.a \
+       USE_DEPS=TRUE \
+       FC=[compiler] \
+       FCFLAGS="[compiler flags]" \
+       OBJ_DIR=[location of object files] \
+       INC_DIR=[location of .mod files]
+
+The first call will produce the dependency file (shared_deps.d), the second call
+will build libmarbl.a and the *.mod files. When building the GCM, you will need
+to add
+
+-I$(INC_DIR)
+
+And when linking
+
+-L$(LIB_DIR) -lmarbl
+
diff --git a/README b/README
@@ -1,6 +1,23 @@
----------
-| ABOUT |
----------
+---------------------------------
+| MARBL Developers Mailing List |
+---------------------------------
+
+You can join the MARBL developers mailing list at
+
+https://groups.google.com/forum/#!forum/marbl-dev
+
+-----------------------
+| MARBL Documentation |
+-----------------------
+
+MARBL documentation is compiled by sphinx and hosted by readthedocs.io.
+It can be found on the web at
+
+https://marbl.readthedocs.io/en/latest/
+
+---------------
+| About MARBL |
+---------------
 
 The MARine Biogeochemistry Library (MARBL) is organized as follows:
 
@@ -70,42 +87,3 @@ The MARine Biogeochemistry Library (MARBL) is organized as follows:
             |                         get_setting() and put_setting()
             └── utils_routines        Make sure all tools provided in marbl_utils_mod.F90
                                        what they claim to do (esp. tests edge cases)
-
----------------------------------------------
-| INSTALLING THE LIBRARY FOR EXTERNAL USAGE |
----------------------------------------------
-
-The Makefile in src/ provides all that is needed to build the library. For
-testing purposes, you can run
-
-$ make [gnu|intel|pgi|nag|cray]
-
-to build with a specific compiler using pre-set compiler flags. However, if
-you want to build MARBL to link with an outside program, you may want more
-control over the compile-time options. To that end, run
-
-$ make OBJ_DIR=[location of object files] depends
-$ make [desired_location_of_lib]/libmarbl.a \
-       USE_DEPS=TRUE \
-       FC=[compiler] \
-       FCFLAGS="[compiler flags]" \
-       OBJ_DIR=[location of object files] \
-       INC_DIR=[location of .mod files]
-
-The first call will produce the dependency file (shared_deps.d), the second call
-will build libmarbl.a and the *.mod files. When building the GCM, you will need
-to add
-
--I$(INC_DIR)
-
-And when linking
-
--L$(LIB_DIR) -lmarbl
-
----------------------------------
-| MARBL Developers Mailing List |
----------------------------------
-
-You can join the MARBL developers mailing list at
-
-https://groups.google.com/forum/#!forum/marbl-dev
diff --git a/docs/sphinx-requirements.txt b/docs/sphinx-requirements.txt
@@ -1,23 +1,35 @@
-alabaster==0.7.9
-Babel==2.3.4
-docutils==0.13.1
-imagesize==0.7.1
-Jinja2==2.9.4
-latexcodec==1.0.4
-MarkupSafe==0.23
+alabaster==0.7.10
+asn1crypto==0.24.0
+Babel==2.6.0
+certifi==2018.4.16
+cffi==1.11.5
+chardet==3.0.4
+cryptography==2.2.2
+docutils==0.14
+enum34==1.1.6
+idna==2.6
+imagesize==1.0.0
+ipaddress==1.0.22
+Jinja2==2.10
+latexcodec==1.0.5
+MarkupSafe==1.0
 oset==0.1.3
 packaging==17.1
 pybtex==0.21
 pybtex-docutils==0.2.1
-Pygments==2.1.3
+pycparser==2.18
+Pygments==2.2.0
+pyOpenSSL==18.0.0
 pyparsing==2.2.0
-pytz==2016.10
+PySocks==1.6.8
+pytz==2018.4
 PyYAML==3.12
-requests==2.12.4
-six==1.10.0
+requests==2.18.4
+six==1.11.0
 snowballstemmer==1.2.1
-Sphinx==1.7.4
-sphinx-rtd-theme==0.1.9
+Sphinx==1.7.5
+sphinx-rtd-theme==0.3.1
 sphinxcontrib-bibtex==0.4.0
-sphinxcontrib-websupport==1.0.1
+sphinxcontrib-websupport==1.1.0
 typing==3.6.4
+urllib3==1.22
diff --git a/docs/src/conf.py b/docs/src/conf.py
@@ -54,9 +54,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'0.0'
+version = u'cesm2.0'
 # The full version, including alpha/beta/rc tags.
-release = u'cesm2.0-n01'
+release = u'cesm2.0'
 
 # Suppress "Created Using Sphinx" footer
 #html_show_sphinx = False
@@ -87,7 +87,7 @@
 #
 #html_theme = 'bizstyle'
 #html_theme = 'sphinxdoc'
-html_theme = 'default'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/docs/src/dev-guide/repo-access/index.rst b/docs/src/dev-guide/repo-access/index.rst
@@ -7,7 +7,6 @@ Rules of engagement
 .. toctree::
    :maxdepth: 1
 
-   license.rst
    developer-agreement.rst
    workflow.rst
    working-on-docs.rst
diff --git a/docs/src/dev-guide/repo-access/license.rst b/docs/src/dev-guide/repo-access/license.rst
diff --git a/docs/src/index.rst b/docs/src/index.rst
@@ -8,7 +8,8 @@ Marine Biogeochemistry Library
 ==============================
 
 The Marine Biogeochemistry Library, or MARBL, is a Fortran software package to be used by ocean general circulation models.
-It is `available via github <https://github.com/marbl-ecosys/MARBL>`_ under an open-source :ref:`license <license>`.
+It is `available via github <https://github.com/marbl-ecosys/MARBL>`_.
+Licensing details are provided in the top-level ``LICENSE``.
 
 ----------------
 About This Guide