pyproject.toml

[project]
name = "mkdocs-jupyter"
description = "Use Jupyter in mkdocs websites"
readme = "README.md"
requires-python = ">=3.9"
license = { "text" = "Apache-2.0" }
keywords = ["mkdocs", "jupyter", "jupyterlab", "notebooks", "documentation"]
authors = [{ name = "Daniel Rodriguez", email = "daniel@danielfrg.com" }]
classifiers = [
  "Development Status :: 5 - Production/Stable",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3.9",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: Implementation :: CPython",
  "Programming Language :: Python :: Implementation :: PyPy",
]
dependencies = [
    "nbconvert>=7.2.9,<8",
    "mkdocs>=1.4.0,<2",
    "mkdocs-material>9.0.0",
    "jupytext>1.13.8,<2",
    "Pygments>2.12.0",
    "ipykernel<7.0.0,>6.0.0",
]
dynamic = ["version"]

[tool.uv]
dev-dependencies = [
    "isort",
    "ruff==0.5.0",
    "build",
    "twine",
    # Testing
    "coverage[toml]",
    "pymdown-extensions",
    "pytest",
    "pytest-cov",
    # Utils
    "jupyterlab",
]

[project.entry-points."mkdocs.plugins"]
mkdocs-jupyter = "mkdocs_jupyter.plugin:Plugin"

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[tool.hatch.build]
artifacts = ["src/mkdocs_jupyter/**"]
exclude = [".github", "docs"]

[tool.hatch.version]
path = "src/mkdocs_jupyter/__about__.py"

[tool.hatch.metadata]
allow-direct-references = true

[tool.pytest.ini_options]
testpaths = ["tests"]
addopts = [
  "-s",
  "-vv",
  "--strict-config",
  "--strict-markers",
  "--ignore=dist",
  "--ignore=site-packages",
  # "--strict-markers",
  "--cov=mkdocs_jupyter",
  "--cov-report=term",
  "--cov-config=pyproject.toml",
]
markers = [
  "pkg: marks tests as Packaging tests",
  "adsapi: mark test that require connection to the API",
]
xfail_strict = true
filterwarnings = ["ignore::DeprecationWarning"]

[tool.coverage.run]
branch = true
parallel = true
omit = ["tests/*"]

[tool.coverage.report]
exclude_lines = [
  "no cov",
  "if __name__ == .__main__.:",
  "if TYPE_CHECKING:",
  "pragma: no cover",
  "raise NotImplementedError",
]


[tool.ruff]
lint.select = [
  "E", # pycodestyle errors
  "W", # pycodestyle warnings
  "F", # pyflakes
  # "I",  # isort
  "B", # flake8-bugbear
]
exclude = [".venv", "tests", "demo"]


[tool.isort]
profile = "black"

[tool.mypy]
strict = true

[tool.pydocstyle]
add_ignore = ["D100", "D101", "D102", "D103", "D104", "D105"]
convention = "numpy"
inherit = false
match_dir = "mkdocs_jupyter"

[tool.codespell]
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
skip = '.git*,*-lock.yaml,*.lock,*.css'
check-hidden = true
# image embeddings and all generally too long lines in "", and all urls
ignore-regex = '(^\s*"(image/\S+": "|.{300,}).*|https?://\S+)'
# ignore-words-list = ''

[project.urls]
Documentation = "https://github.com/danielfrg/mkdocs-jupyter#readme"
Issues = "https://github.com/danielfrg/mkdocs-jupyter/issues"
Source = "https://github.com/danielfrg/mkdocs-jupyter"