Skip to content

Commit

Permalink
docs: Add integration to readthedocs.
Browse files Browse the repository at this point in the history
  • Loading branch information
bvanelli committed Oct 3, 2024
1 parent 3ec3bc1 commit 2a2ddb1
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 4 deletions.
19 changes: 19 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# 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"

mkdocs:
configuration: mkdocs.yml

# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
4 changes: 4 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
mkdocs-material
mkdocs
mkdocstrings-python
griffe-fieldz
4 changes: 0 additions & 4 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,4 @@ pytest-mock
pytest
pytest-cov
testcontainers
mkdocs-material
mkdocs
mkdocstrings-python
griffe-fieldz
pre-commit

0 comments on commit 2a2ddb1

Please sign in to comment.