Skip to content

Commit

Permalink
use poetry in readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
MAfarrag committed Dec 12, 2024
1 parent 84156bb commit 3c73301
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 8 deletions.
14 changes: 9 additions & 5 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,16 @@ build:
os: "ubuntu-22.04"
tools:
python: "3.11"
jobs:
post_create_environment:
# Install poetry
# https://python-poetry.org/docs/#installing-manually
- python -m pip install poetry
post_install:
# Install dependencies with 'docs' dependency group
# https://python-poetry.org/docs/managing-dependencies/#dependency-groups
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs

python:
install:
- requirements: docs/requirements.txt
- method: pip
path: .

# Optionally build your docs in additional formats such as PDF and ePub
formats: all
1 change: 0 additions & 1 deletion docs/requirements.txt

This file was deleted.

6 changes: 4 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,13 @@ darglint = "^1.8.1"
reorder-python-imports = "^3.14.0"
pre-commit-hooks = "^5.0.0"
pre-commit-commit-msg-hooks = "^0.1.0"
sphinx = "^8.1.3"
pydata-sphinx-theme = "^0.15.2"
moto = "^5.0.22"
flake8-pyproject = "^1.2.3"

[tool.poetry.group.docs.dependencies]
sphinx = "^8.1.3"
pydata-sphinx-theme = "^0.15.2"

#[tool.poetry.extras]
#docs = ["sphinx", "sphinx_rtd_theme", "sphinx-autodoc-typehints", "recommonmark", "myst-parser"]
#sphinx = "^7.2.6"
Expand Down

0 comments on commit 3c73301

Please sign in to comment.