From 77f0b1f06d1158de483976e0df129b86467edf7e Mon Sep 17 00:00:00 2001 From: Marc Bonnici Date: Thu, 28 Oct 2021 10:20:38 +0100 Subject: [PATCH] docs: Add readthedocs config and requirements.txt The default versions used for sphinx and docuilts on readthedocs are no longer compatible. Explicitly list the package versions that should be used when building the documentation. --- .readthedocs.yml | 20 ++++++++++++++++++++ doc/requirements.txt | 3 +++ 2 files changed, 23 insertions(+) create mode 100644 .readthedocs.yml create mode 100644 doc/requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..a5dac70 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,20 @@ +# .readthedocs.yml +# 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: + builder: html + configuration: doc/conf.py + +# Build the docs in additional formats such as PDF and ePub +formats: all + +# Set the version of Python and requirements required to build your docs +python: + version: 3.7 + install: + - requirements: doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..2caa3be --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,3 @@ +sphinx==4.2 +sphinx-rtd-theme==1.0.0 +docutils<0.18