launchpad-reviewers team mailing list archive

[Jürgen Gmach <mp+415271@xxxxxxxxxxxxxxxxxx>]

Jürgen Gmach has proposed merging ~jugmac00/turnip:fix-rtd into turnip:master.

Commit message:
Fix doc building on Read the Docs

Requested reviews:
  Launchpad code reviewers (launchpad-reviewers)

For more details, see:
https://code.launchpad.net/~jugmac00/turnip/+git/turnip/+merge/415271
-- 
Your team Launchpad code reviewers is requested to review the proposed merge of ~jugmac00/turnip:fix-rtd into turnip:master.

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 0000000..4ec7b2d
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,21 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docs/requirements.txt
diff --git a/docs/requirements.in b/docs/requirements.in
new file mode 100644
index 0000000..6966869
--- /dev/null
+++ b/docs/requirements.in
@@ -0,0 +1 @@
+sphinx
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 0000000..d61c123
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,56 @@
+#
+# This file is autogenerated by pip-compile with python 3.8
+# To update, run:
+#
+#    pip-compile docs/requirements.in
+#
+alabaster==0.7.12
+    # via sphinx
+babel==2.9.1
+    # via sphinx
+certifi==2021.10.8
+    # via requests
+charset-normalizer==2.0.11
+    # via requests
+docutils==0.17.1
+    # via sphinx
+idna==3.3
+    # via requests
+imagesize==1.3.0
+    # via sphinx
+importlib-metadata==4.10.1
+    # via sphinx
+jinja2==3.0.3
+    # via sphinx
+markupsafe==2.0.1
+    # via jinja2
+packaging==21.3
+    # via sphinx
+pygments==2.11.2
+    # via sphinx
+pyparsing==3.0.7
+    # via packaging
+pytz==2021.3
+    # via babel
+requests==2.27.1
+    # via sphinx
+snowballstemmer==2.2.0
+    # via sphinx
+sphinx==4.4.0
+    # via -r docs/requirements.in
+sphinxcontrib-applehelp==1.0.2
+    # via sphinx
+sphinxcontrib-devhelp==1.0.2
+    # via sphinx
+sphinxcontrib-htmlhelp==2.0.0
+    # via sphinx
+sphinxcontrib-jsmath==1.0.1
+    # via sphinx
+sphinxcontrib-qthelp==1.0.3
+    # via sphinx
+sphinxcontrib-serializinghtml==1.1.5
+    # via sphinx
+urllib3==1.26.8
+    # via requests
+zipp==3.7.0
+    # via importlib-metadata