From 7f9d59ac09609f6cc684eb1f7dff84f1aec1d764 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Fri, 28 Jan 2022 19:01:22 -0500 Subject: [PATCH 1/3] Update .readthedocs.yaml to fix Python version selection --- .readthedocs.yaml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f8b2891..1c7aeea 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,8 +8,11 @@ # Required version: 2 +build: + tools: + python: "3" + python: - version: "3.x" install: - requirements: docs/requirements.txt - requirements: requirements.txt From cd2787c8b1c9b474714c134af303d6d49472c622 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Fri, 28 Jan 2022 19:05:53 -0500 Subject: [PATCH 2/3] Update README to include link to documentation --- README.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.rst b/README.rst index f036443..b86df6c 100644 --- a/README.rst +++ b/README.rst @@ -79,5 +79,7 @@ before contributing to help this project stay welcoming. Documentation ============= +API documentation for this library can be found on `Read the Docs `_. + For information on building library documentation, please check out `this guide `_. From b4a4e9047ae353d785fafae9e0f3c0a354da0f6c Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Fri, 28 Jan 2022 19:13:11 -0500 Subject: [PATCH 3/3] Move Documentation section above Contributing section --- README.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index b86df6c..cdd7aaa 100644 --- a/README.rst +++ b/README.rst @@ -69,13 +69,6 @@ Or the following command to update an existing version: circup update -Contributing -============ - -Contributions are welcome! Please read our `Code of Conduct -`_ -before contributing to help this project stay welcoming. - Documentation ============= @@ -83,3 +76,10 @@ API documentation for this library can be found on `Read the Docs `_. + +Contributing +============ + +Contributions are welcome! Please read our `Code of Conduct +`_ +before contributing to help this project stay welcoming.