-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
32 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Read the Docs configuration file for MkDocs projects | ||
# 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" | ||
tools: | ||
python: "3.12" | ||
jobs: | ||
post_create_environment: | ||
# Install poetry | ||
# https://python-poetry.org/docs/#installing-manually | ||
# - pip install poetry | ||
- curl -sSL https://install.python-poetry.org | python3 - | ||
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 | ||
- make build | ||
|
||
mkdocs: | ||
configuration: mkdocs.yml | ||
# Optionally declare the Python requirements required to build your docs | ||
# python: | ||
# install: | ||
# - requirements: docs/requirements.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters