Skip to content

Commit

Permalink
feat(readthedocs): create configuration file
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Oliveira <[email protected]>
Signed-off-by: David Cerdeira <[email protected]>
  • Loading branch information
danielRep authored and DavidMCerdeira committed Aug 26, 2024
1 parent e531d8b commit 5499395
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# .readthedocs.yaml
# Read the Docs configuration file
# 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.12"
install:
- requirements: source/requirements.txt
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
# golang: "1.19"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: source/conf.py

# 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
3 changes: 3 additions & 0 deletions source/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
sphinx
sphinxcontrib-spelling
sphinx-tabs

0 comments on commit 5499395

Please sign in to comment.