From 9a04f385c3cdceb4d3a2cbfb83d8c51f6f9defce Mon Sep 17 00:00:00 2001 From: Kristin Berry <kberry@usgs.gov> Date: Mon, 8 Mar 2021 15:52:18 -0700 Subject: [PATCH] Adds .readthedocs.yaml file for new ReadTheDocs builds. (#159) * Add .readthedocs.yaml file and correct tile for tutorials * Also add documentation badge * Move build documentation badge Co-authored-by: Kristin Berry <kberry@gyro.wr.usgs.gov> --- .readthedocs.yaml | 18 ++++++++++++++++++ README.md | 3 +++ docs/users/tutorials/index.rst | 4 ++-- 3 files changed, 23 insertions(+), 2 deletions(-) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..49efc46 --- /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 dcb08ee..073266c 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 97df55a..9620a29 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 -- GitLab