Skip to content

Commit

Permalink
Config for readthedocs deploy
Browse files Browse the repository at this point in the history
  • Loading branch information
okaycj committed Oct 21, 2024
1 parent bb6754c commit 45ab1b7
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
31 changes: 31 additions & 0 deletions .readthedocs.yml
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
2 changes: 1 addition & 1 deletion makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 45ab1b7

Please sign in to comment.