formatting

docs/sphinx/.readthedocs.yaml

@@ -1,35 +1,31 @@
-# Read the Docs configuration file for Sphinx projects
+# .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 OS, Python version and other tools you might need
+# Set the version of Python and other tools you might need
 build:
-  os: ubuntu-22.04
-  tools:
-    python: "3.9"
-    # You can also specify other tool versions:
-    # nodejs: "20"
-    # rust: "1.70"
-    # golang: "1.20"
+   os: ubuntu-22.04
+   tools:
+     python: "3.9"
+     # You can also specify other tool versions:
+     # nodejs: "16"
+     # rust: "1.55"
+     # golang: "1.17"
 
-# Build documentation in the "docs/" directory with Sphinx
+# Build documentation in the docs/ directory with Sphinx
 sphinx:
-  configuration: docs/sphinx/conf.py
-  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
-  # builder: "dirhtml"
-  # Fail on all warnings to avoid broken references
-  # fail_on_warning: true
+   configuration: docs/sphinx/conf.py
 
-# Optionally build your docs in additional formats such as PDF and ePub
+# If using Sphinx, optionally build your docs in additional formats such as PDF
 # formats:
-#   - pdf
-#   - epub
+#    - pdf
 
-# Optional but recommended, declare the Python requirements required
-# to build your documentation
-# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
- python:
+# Optionally declare the Python requirements required to build your docs
+python:
    install:
-     - requirements: docs/requirements.txt
+   - requirements: docs/requirements.txt
+   - method: pip
+     path: .