Fix ReadTheDocs Builds (#271)

* create .readthedocs.yaml

* add newline

* update specs.rst

addressing https://stackoverflow.com/a/56469300 (sphinx >=1.3)

* update sys path

addressing https://stackoverflow.com/a/44980548

* fix: lint

* update sys path

* temp: add docs/requirements.txt

* temp: autodoc_mock_imports

* remove docs/requirements.txt

* Update conf.py

* update autodoc_mock_imports

* temp: disable sys path

this should fail the readthedocs build: https://readthedocs.org/projects/python-driver-for-arangodb/builds/

* revert last commit

* attempt: undo specs.rst changes

(the less changes the better)

* temp: remove `requests` & `urlib3` from autodoc_mock_imports

* temp: remove `requests_toolbelt` from `autodoc_mock_imports`

* reintroduce docs/requirements.txt

* temp: disable `autodoc_mock_imports`

* new: `importlib_metadata` in docs/requirements.txt

* new: `jwt` in `docs/requirements.txt`

* remove: `autodoc_mock_imports`

Author: aMahanna

.readthedocs.yaml

@@ -0,0 +1,31 @@
+# Read the Docs configuration file for Sphinx projects
+# 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
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/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
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt

docs/conf.py

@@ -1,3 +1,8 @@
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath(".."))
+
 project = "python-arango"
 copyright = "2016-2022, Joohwan Oh"
 author = "Joohwan Oh"

docs/requirements.txt

@@ -0,0 +1,3 @@
+requests_toolbelt
+importlib_metadata
+jwt