From 97453624cd9401acbd737897eb61dc4b12fc4df6 Mon Sep 17 00:00:00 2001 From: CJ Green <44074998+okaycj@users.noreply.github.com> Date: Mon, 21 Oct 2024 11:45:40 -0400 Subject: [PATCH] Config for readthedocs deploy (#73) --- .readthedocs.yml | 31 +++++++++++++++++++++++++++++++ makefile | 2 +- 2 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 .readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 00000000..41c560b2 --- /dev/null +++ b/.readthedocs.yml @@ -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 diff --git a/makefile b/makefile index f5312c46..37de1e2c 100644 --- a/makefile +++ b/makefile @@ -2,7 +2,7 @@ serve: poetry poetry run mkdocs serve -a localhost:8888 build: poetry - poetry run mkdocs build --strict + poetry run mkdocs build poetry: poetry install --no-root --sync