Skip to content

Commit

Permalink
Merge pull request #58 from neuronflow/fix/broken-rtd
Browse files Browse the repository at this point in the history
Update .readthedocs.yaml configuration file
  • Loading branch information
neuronflow authored Mar 5, 2024
2 parents c77a822 + 693693d commit 5ee6158
Showing 1 changed file with 13 additions and 22 deletions.
35 changes: 13 additions & 22 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,29 +1,20 @@
# .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 version of Python and other tools you might need
build:
os: ubuntu-22.04
os: "ubuntu-22.04"
tools:
python: "3.10"
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
# golang: "1.19"
jobs:
post_create_environment:
# Install poetry
# https://python-poetry.org/docs/#installing-manually
- pip install poetry
post_install:
# Install dependencies with 'docs' dependency group
# https://python-poetry.org/docs/managing-dependencies/#dependency-groups
# VIRTUAL_ENV needs to be set manually for now.
# See https://github.com/readthedocs/readthedocs.org/pull/11152/
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs

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

# If using Sphinx, optionally build your docs in additional formats such as PDF
# formats:
# - pdf

# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
configuration: docs/source/conf.py

0 comments on commit 5ee6158

Please sign in to comment.