Adding requirements for docs (#4)

Author: apetenchea

.github/workflows/docs.yaml

@@ -0,0 +1,28 @@
+name: Docs
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    name: Docs
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Fetch all tags and branches
+        run: git fetch --prune --unshallow
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: pip install .[dev]
+
+      - name: Generate Sphinx HTML
+        run: python -m sphinx -b html -W docs docs/_build

docs/config.py

@@ -1,4 +1,11 @@
 project = "python-arango-async"
 copyright_notice = "ArangoDB"
 author = "Alexandru Petenchea, Anthony Mahanna"
+extensions = [
+    "sphinx_rtd_theme",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.viewcode",
+]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+master_doc = "index"

docs/index.rst

@@ -0,0 +1,8 @@
+python-arango-async
+-------------------
+
+Welcome to the documentation for **python-arango-async**, a Python driver for ArangoDB_.
+
+**The driver is currently work in progress and not yet ready for use.**
+
+.. _ArangoDB: https://www.arangodb.com

docs/requirements.txt

@@ -0,0 +1 @@
+sphinx_rtd_theme