pyproject.toml

[tool.poetry]
authors = ["Laurens van der Tas <laurens.vandertas@gmail.com>"]
description = """\
Automatic documentation for your project, using MkDocstrings with MkDocs Material. \
Also shows the usage of pre-commit hooks and CI/CD, using GitHub Actions.\
"""
include = [
  "tests",
  "typings",
  ".github",
  ".vscode",
  ".env.example",
  ".editorconfig",
  ".pre-commit-config.yaml",
  "Makefile",
]
name = "mkdocs-demo"
packages = [
  {include = "mkdocs_demo", from = "src"},
]
readme = "README.md"
version = "1.0.0"

[tool.poetry.scripts]
# Mypy typing stubs
gen-typings = "src.mkdocs_demo.scripts.mypy:gen_types"
# Makedocs
md-build = "src.mkdocs_demo.scripts.mkdocs:build"
md-serve = "src.mkdocs_demo.scripts.mkdocs:serve"
# Pre-commit hooks
pc = "src.mkdocs_demo.scripts.precommit:run"
pc-install = "src.mkdocs_demo.scripts.precommit:install"
pc-update = "src.mkdocs_demo.scripts.precommit:update"

[tool.poetry.dependencies]
install = "^1.3.5"
markdown-callouts = "^0.3.0"
markdown-exec = {extras = ["ansi"], version = "^1.8.0"}
mike = "^2.0.0"
mkdocs-gen-files = "^0.5.0"
mkdocs-literate-nav = "^0.6.1"
mkdocs-material = {extras = ["imaging"], version = "^9.5.3"}
mkdocs-minify-plugin = "^0.7.2"
mkdocs-section-index = "^0.3.8"
mkdocstrings = {extras = ["python"], version = "^0.24.0"}
python = "^3.11"

[tool.poetry.group.dev.dependencies]
black = "^23.12.1"
ipykernel = "^6.28.0"
ipywidgets = "^8.1.1"
mypy = "^1.8.0"
pre-commit = "^3.6.0"
ruff = "^0.1.15"

[tool.poetry.group.test.dependencies]
pytest = "^7.4.4"

[build-system]
build-backend = "poetry.core.masonry.api"
requires = ["poetry-core"]