diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..bb9d1590 --- /dev/null +++ b/.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 diff --git a/docs/conf.py b/docs/conf.py index 9f432aee..77fe6bb8 100644 --- a/docs/conf.py +++ b/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" diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..6a02df0e --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +requests_toolbelt +importlib_metadata +jwt