Skip to content

Commit

Permalink
Add readthedocs config
Browse files Browse the repository at this point in the history
  • Loading branch information
freddyheppell committed Jul 11, 2024
1 parent 6916ceb commit 14fe6f9
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 93 deletions.
18 changes: 18 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Read the Docs configuration file for MkDocs projects

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.9"
jobs:
post_create_environment:
- pip install poetry==1.8.3
post_install:
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs

mkdocs:
configuration: mkdocs.yml
93 changes: 1 addition & 92 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ mkdocs-material = "^9.5.28"
mkdocstrings = "^0.25.1"
mkdocstrings-python = "^1.10.5"
black = "^24.4.2"
mike = "^2.1.2"

[build-system]
requires = ["poetry-core>=1.0.0"]
Expand Down

0 comments on commit 14fe6f9

Please sign in to comment.