diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000000000000000000000000000000000000..49efc46d01072d895af9d2cfce758e2ac1409a51 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,18 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Optionally build your docs in additional formats such as PDF +formats: + - pdf + +conda: + environment: environment.yml + diff --git a/README.md b/README.md index dcb08eed6738b90e61d3fa43cdc72369f8c71154..073266c1112be231c2636d8dab3b234a93b08a40 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,8 @@ Current build status [](https://travis-ci.org/conda-forge/plio-feedstock) [](https://ci.appveyor.com/project/conda-forge/plio-feedstock/branch/master) +[](https://plio.readthedocs.io/en/latest/?badge=latest) + Current release info ==================== @@ -47,6 +49,7 @@ We maintain a development branch of plio that is used as a staging area for our [](https://coveralls.io/github/USGS-Astrogeology/plio?branch=master) + To install the development version: ``` diff --git a/docs/users/tutorials/index.rst b/docs/users/tutorials/index.rst index 97df55abe1a3d7ae1b7718d8482323d5ce93cc37..9620a2900567441415ab4d1c1e607f26fd3ef5d2 100644 --- a/docs/users/tutorials/index.rst +++ b/docs/users/tutorials/index.rst @@ -1,5 +1,5 @@ -Getting Started with AutoCNet -============================= +Getting Started with Plio +========================= .. toctree:: :maxdepth: 1