Skip to content

Commit

Permalink
docs: add Read the Docs config file (#186)
Browse files Browse the repository at this point in the history
Co-authored-by: Aditya Arora <aditya.arora@ambient.ai>
  • Loading branch information
alohamora and aditya-ambient committed Dec 2, 2023
1 parent d4c1280 commit 80f0136
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 1 deletion.
32 changes: 32 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# 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.10"
# You can also specify other tool versions:
# nodejs: "20"
# rust: "1.70"
# golang: "1.20"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/api/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

python:
install:
- requirements: docs/api/requirements.txt
3 changes: 3 additions & 0 deletions docs/api/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Sphinx==7.2.6
readthedocs-sphinx-ext==2.2.3
sphinx-rtd-theme==1.3.0
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
addict==2.2.1
celery==5.2.2
connexion>=2.11.2
connexion>=2.11.2,<3.0.0
cryptography==41.0.3
Flask==2.2.5
flask-authz==2.5.0
Expand Down

0 comments on commit 80f0136

Please sign in to comment.