pyproject.toml

[build-system]
build-backend = "setuptools.build_meta"
requires = [
    "setuptools>=61.2",
    "setuptools_scm",
]

[project]
classifiers = [
    "Development Status :: 2 - Pre-Alpha",
    "Intended Audience :: Developers",
    "Intended Audience :: Education",
    "Intended Audience :: Science/Research",
    "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
    "Natural Language :: English",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python",
    "Topic :: Scientific/Engineering :: Physics",
    "Topic :: Scientific/Engineering",
]
description = "Documentation of the BESIII Offline Software System"
dynamic = ["version"]
keywords = [
    "BESIII",
    "HEP",
    "IHEP",
    "particle physics",
    "particles",
    "physics",
]
license = {text = "GPLv3 or later"}
name = "bossdoc"
requires-python = ">=3.9"

[project.optional-dependencies]
dev = [
    "bossdoc[doc]",
    "bossdoc[sty]",
    "jupyterlab",
    "jupyterlab-code-formatter",
    "sphinx-autobuild",
    "tox >=1.9",
]
doc = [
    "Sphinx >=3",
    "ipywidgets",
    "matplotlib",
    "myst-nb",
    "sphinx-api-relink",
    "sphinx-book-theme",
    "sphinx-comments",
    "sphinx-copybutton",
    "sphinx-design",
    "sphinx-pybtex-etal-style",
    "sphinx-thebe",
    "sphinx-togglebutton",
    "sphinxcontrib-bibtex >=2",
]
sty = [
    "bossdoc[types]",
    "pre-commit >=1.4.0",
    "ruff",
]
types = [
    "sphinx-api-relink",
]

[project.readme]
content-type = "text/markdown"
file = "README.md"

[project.urls]
Changelog = "https://github.com/redeboer/bossdoc/releases"
Documentation = "http://bes3.rtfd.io"
Source = "https://github.com/redeboer/bossdoc"
Tracker = "https://github.com/redeboer/bossdoc/issues"

[tool.setuptools]
include-package-data = false

[tool.setuptools_scm]
local_scheme = "no-local-version"
version_scheme = "post-release"
write_to = "version.py"

[tool.pixi.project]
channels = ["conda-forge"]
platforms = ["linux-64"]

[tool.pixi.activation.env]
PRETTIER_LEGACY_CLI = "1"

[tool.pixi.dependencies]
python = "3.12.*"

[tool.pixi.environments]
default = {features = [
    "dev",
    "doc",
    "sty",
    "types",
]}

[tool.pixi.feature.dev.tasks.ci]
depends_on = ["docnb", "linkcheck", "sty"]

[tool.pixi.feature.dev.tasks.doc]
cmd = """
sphinx-build \
    --builder dirhtml \
    --color \
    --fail-on-warning \
    --keep-going \
    --show-traceback \
    docs/ docs/_build/html
"""
env = {PYTHONWARNINGS = ""}

[tool.pixi.feature.dev.tasks.doclive]
cmd = """
sphinx-autobuild \
    --builder dirhtml \
    --open-browser \
    --re-ignore .*/__pycache__/.* \
    --re-ignore .*/.ipynb_checkpoints/.* \
    --re-ignore .*\\.gitignore \
    --re-ignore .*\\.tmp \
    --re-ignore docs/_build/.* \
    --re-ignore docs/_images/.* \
    --re-ignore docs/.*\\.csv \
    --re-ignore docs/.*\\.gif \
    --re-ignore docs/.*\\.gv \
    --re-ignore docs/.*\\.inv \
    --re-ignore docs/.*\\.json \
    --re-ignore docs/.*\\.pickle \
    --re-ignore docs/.*\\.png \
    --re-ignore docs/.*\\.svg \
    --re-ignore docs/.*\\.yaml \
    --re-ignore docs/.*\\.yml \
    --re-ignore docs/api/.* \
    --watch docs \
    --watch src \
    docs/ docs/_build/html
"""
env = {PYTHONWARNINGS = ""}

[tool.pixi.feature.dev.tasks.docnb]
cmd = "pixi run doc"
env = {EXECUTE_NB = "\"yes\""}

[tool.pixi.feature.dev.tasks.linkcheck]
cmd = """
sphinx-build \
    --builder linkcheck \
    --color \
    --show-traceback \
    docs/ docs/_build/linkcheck
"""
env = {PYTHONWARNINGS = ""}

[tool.pixi.feature.dev.tasks.sty]
cmd = "pre-commit run  -a"

[tool.pixi.pypi-dependencies]
bossdoc = {path = ".", editable = true}

[tool.pyright]
exclude = [
    ".git",
    ".tox",
    "docs/_build",
]
include = [
    "docs/conf.py",
    "src",
    "tests",
]
reportGeneralTypeIssues = false
reportMissingParameterType = false
reportMissingTypeStubs = false
reportUnboundVariable = false
reportUnknownArgumentType = false
reportUnknownMemberType = false
reportUnknownParameterType = false
reportUnknownVariableType = false
reportUnusedClass = true
reportUnusedFunction = true
reportUnusedImport = true
reportUnusedVariable = true
typeCheckingMode = "strict"

[tool.ruff]
extend-exclude = ["typings"]
preview = true
show-fixes = true

[tool.ruff.format]
docstring-code-format = true
line-ending = "lf"

[tool.ruff.lint]
ignore = [
    "ANN401",
    "COM812",
    "CPY001",
    "D101",
    "D102",
    "D103",
    "D105",
    "D107",
    "D203",
    "D213",
    "D407",
    "D416",
    "DOC",
    "E501",
    "FURB101",
    "FURB103",
    "FURB140",
    "G004",
    "ISC001",
    "PLW1514",
    "PT001",
    "PTH",
    "SIM108",
    "UP036",
]
select = ["ALL"]
task-tags = ["cspell"]

[tool.ruff.lint.isort]
split-on-trailing-comma = false

[tool.ruff.lint.per-file-ignores]
"docs/*" = [
    "E402",
    "INP001",
    "S101",
    "S113",
    "T201",
]
"docs/conf.py" = [
    "A00",
    "B006",
    "D100",
    "PLC2701",
    "PLR0913",
]
"setup.py" = ["D100"]

[tool.ruff.lint.pydocstyle]
convention = "google"

[tool.tomlsort]
all = false
ignore_case = true
in_place = true
sort_first = [
    "build-system",
    "project",
    "tool.setuptools",
    "tool.setuptools_scm",
]
spaces_indent_inline_array = 4
trailing_comma_inline_array = true