Skip to content

Commit

Permalink
Updating documentation configurations.
Browse files Browse the repository at this point in the history
  • Loading branch information
teald committed Dec 9, 2022
1 parent 7407138 commit b508757
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 19 deletions.
33 changes: 15 additions & 18 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,29 +1,26 @@
# .readthedocs.yaml
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
# Build and VM configuration
build:
os: ubuntu-20.04
os: 'ubuntu-22.04'
tools:
python: "3.9"
# You can also specify other tool versions:
# nodejs: "16"
# rust: "1.55"
# golang: "1.17"
python: '3.10'

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
# Python requirements
python:
install:
- requirements: docs/requirements.txt
- method: pip
path: .

# If using Sphinx, optionally build your docs in additional formats such as PDF
# formats:
# - pdf
# Build with sphinx
sphinx:
configuration: docs/conf.py

# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
# Build all the things
formats: all
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# The requirements here are only for building the docs using
# sphinx/readthedocs.io
m2r2
sphinx_rtd_theme
sphinx_rtd_theme>=0.5.1
poetry
pre-commit
sphinx-autorun
Expand Down

0 comments on commit b508757

Please sign in to comment.