1
0
mirror of https://github.com/ARM-software/devlib.git synced 2024-10-05 10:20:51 +01:00

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.
This commit is contained in:
Marc Bonnici 2021-10-28 10:20:38 +01:00
parent b4c76007c8
commit 77f0b1f06d
2 changed files with 23 additions and 0 deletions

20
.readthedocs.yml Normal file
View File

@ -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

3
doc/requirements.txt Normal file
View File

@ -0,0 +1,3 @@
sphinx==4.2
sphinx-rtd-theme==1.0.0
docutils<0.18