Skip to content

Commit

Permalink
- migrate docs install to poetry
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcelRosier committed Nov 28, 2023
1 parent e41ae26 commit 1131180
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 22 deletions.
21 changes: 12 additions & 9 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,23 @@ build:
os: ubuntu-22.04
tools:
python: "3.10"
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
# golang: "1.19"
jobs:
post_create_environment:
# Install poetry
# https://python-poetry.org/docs/#installing-manually
- pip install poetry
# Tell poetry to not use a virtual environment
- poetry config virtualenvs.create false
post_install:
# Install dependencies with 'docs' dependency group
# https://python-poetry.org/docs/managing-dependencies/#dependency-groups
- poetry install --with docs

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/conf.py

configuration: docs/source/conf.py
# If using Sphinx, optionally build your docs in additional formats such as PDF
# formats:
# - pdf

# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
5 changes: 0 additions & 5 deletions docs/requirements.txt

This file was deleted.

23 changes: 15 additions & 8 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
[build-system]
requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning>=1.0.0,<2.0.0"]
build-backend = "poetry_dynamic_versioning.backend"

[tool.poetry-dynamic-versioning]
enable = true

[tool.poetry]
name = "panoptica"
version = "0.0.0"
Expand All @@ -9,10 +16,6 @@ documentation = "https://panoptica.readthedocs.io/"
readme = "README.md"


[tool.poetry-dynamic-versioning]
enable = true


# Add the exclude field directly under [tool.poetry]
exclude = ["examples", "benchmark"]

Expand All @@ -27,7 +30,11 @@ pytest = "^6.2.5"
pytest-cov = "^3.0.0"
pytest-mock = "^3.6.0"

[build-system]
requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning>=1.0.0,<2.0.0"]
build-backend = "poetry_dynamic_versioning.backend"
# build-backend = "poetry.core.masonry.api"
[tool.poetry.group.docs]
optional = true

[tool.poetry.group.docs.dependencies]
Sphinx = ">=7.0.0"
sphinx-copybutton = ">=0.5.2"
sphinx-rtd-theme = ">=1.3.0"
myst-parser = ">=2.0.0"

0 comments on commit 1131180

Please sign in to comment.