Add .readthedocs.yaml file.
authorMikhail Terekhov <termim@gmail.com>
Sun, 17 Dec 2023 20:59:52 +0000 (15:59 -0500)
committerMikhail Terekhov <termim@gmail.com>
Mon, 16 Dec 2024 17:57:15 +0000 (12:57 -0500)
Now to create documentation on readthedocs.org the project must have
a configuration file.

Signed-off-by: Mikhail Terekhov <termim@gmail.com>
.readthedocs.yaml [new file with mode: 0644]

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644 (file)
index 0000000..e731de6
--- /dev/null
@@ -0,0 +1,20 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: doc/conf.py
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+   - epub
+   - pdf