summaryrefslogtreecommitdiffstats
path: root/.readthedocs.yml
diff options
context:
space:
mode:
authorCalum Lind <calumlind+deluge@gmail.com>2019-05-21 02:19:57 +0100
committerCalum Lind <calumlind+deluge@gmail.com>2019-05-21 15:23:45 +0100
commit65f6ede8b24ad093285a514360a1082cec892f49 (patch)
tree6f778626ae41890cd3dc9e7a1483f5e3e765e21d /.readthedocs.yml
parent515dbcc5d9de572f46ebacb2baa47ae762b06036 (diff)
downloaddeluge-65f6ede8b24ad093285a514360a1082cec892f49.tar.gz
deluge-65f6ede8b24ad093285a514360a1082cec892f49.tar.bz2
deluge-65f6ede8b24ad093285a514360a1082cec892f49.zip
[Docs] Updates and fixes to build on Python 3
- Updates to the sphinx conf - Applied Mock fixes to build on Python 3. - Group patches at bottom of conf file. - Use just a major.minor for version. - Specify Sphinx 2.0 version requirement. - Move requirements.txt to docs dir. - Add readthedocs config - Fix docstring code block rst formatting issue.
Diffstat (limited to '.readthedocs.yml')
-rw-r--r--.readthedocs.yml20
1 files changed, 20 insertions, 0 deletions
diff --git a/.readthedocs.yml b/.readthedocs.yml
new file mode 100644
index 000000000..1b43c5ed2
--- /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:
+ configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+ version: 3.7
+ install:
+ - requirements: requirements.txt
+ - requirements: docs/requirements.txt