Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update .readthedocs.yml #1474

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 32 additions & 9 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,44 @@
# Required
version: 2

# Set the version of Python and other tools you might need
# Set the version of the operating system and tools
build:
os: ubuntu-22.04
tools:
python: "3.10"

# Build documentation in the docs/ directory with Sphinx
# Build documentation using Sphinx, pointing to the configuration file
sphinx:
configuration: docs/conf.py
configuration: docs/conf.py

# If using Sphinx, optionally build your docs in additional formats such as PDF
# formats:
# - pdf
# Build documentation in additional formats (uncomment if needed)
formats:
- html
- pdf
- epub

# Optionally declare the Python requirements required to build your docs
# Declare Python requirements for building the documentation
python:
install:
- requirements: docs/sphinx_requirements.txt
install:
- requirements: docs/sphinx_requirements.txt
# Install additional dependencies (optional)
- method: pip
path: docs/extra_requirements.txt

# Add optional configurations for building and previews
build:
image: latest
apt_packages:
- graphviz # Example: Install system packages if needed

# Set environment variables if necessary
environment:
variables:
SPHINXOPTS: "-W" # Treat warnings as errors

# Configure pre- and post-build hooks (if applicable)
# hooks:
# pre_build:
# - echo "Running pre-build tasks..."
# post_build:
# - echo "Running post-build tasks..."