Skip to content

Commit 36bd48a

Browse files
authored
Minimal docs setup (#3)
* CI setup * Docs minimal setup
1 parent a359b45 commit 36bd48a

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

.readthedocs.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the OS, Python version and other tools you might need
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.12"
13+
14+
# Build documentation in the "docs/" directory with Sphinx
15+
sphinx:
16+
configuration: docs/conf.py
17+
fail_on_warning: true
18+
19+
# Optional but recommended, declare the Python requirements required
20+
# to build your documentation
21+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
22+
python:
23+
install:
24+
- requirements: docs/requirements.txt

docs/config.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
11
project = "python-arango-async"
2+
copyright_notice = "ArangoDB"
3+
author = "Alexandru Petenchea, Anthony Mahanna"
4+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

0 commit comments

Comments
 (0)