Merge pull request #170 from hsorby/docs

Update documentation build on readthedocs
LungNoodle · Dec 2, 2024 · c7a8331 · c7a8331
2 parents 500ff7c + dc2e3de
commit c7a8331
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -52,3 +52,6 @@ __pycache__/
 # PyCharm
 .idea/
 
+# Sphinx documentation
+_build/
+
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,14 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+sphinx:
+  configuration: documentation/conf.py
+
+python:
+  install:
+    - requirements: documentation/requirements.txt
+
diff --git a/documentation/conf.py b/documentation/conf.py
@@ -71,7 +71,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language ='en' 
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-Original file line number
+Diff line change
@@ Expand Up / @@ -52,3 +52,6 @@ __pycache__/ @@
     # PyCharm
     .idea/
+    # Sphinx documentation
+    _build/