pyproject.toml

# This file is generated from sphinx-notes/cookiecutter.
# You need to consider modifying the TEMPLATE or modifying THIS FILE.

# This file is used to configure your project.
# Read more about the various options under:
# https://packaging.python.org/en/latest/specifications/declaring-project-metadata/#declaring-project-metadata

[project]
name = "sphinxnotes-snippet"
description = "Sphinx documentation snippets manager"
readme = "README.rst"
license = { file = "BSD-3-Clause" }
authors = [ { name = "Shengyu Zhang" } ]
maintainers = [ { name = "Shengyu Zhang" } ]
keywords = ["sphinx", "extension", "documentation"] # TOOD: additional_keywords
classifiers = [
    "Development Status :: 4 - Beta",
    "Environment :: Plugins",
    "Framework :: Sphinx",
    "Framework :: Sphinx :: Extension",
    "License :: OSI Approved :: BSD License",
    "Operating System :: OS Independent",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
    "Topic :: Documentation",
    "Topic :: Documentation :: Sphinx",
    "Topic :: Utilities",
]

requires-python = ">=3.12"
dependencies = [
    "Sphinx >= 4",
    "langid",
    "jieba",
    "python-pinyin",
    "pyxdg",
    "stopwordsiso",
    "setuptools", # req by stopwordsiso, https://stackoverflow.com/a/39930983/4799273
    "wcwidth",
    "wordsegment",
]

dynamic = ["version"] # required by setuptools_scm, see section [build-system]

[project.optional-dependencies]
dev = [
    "build",
    "twine",
    "cruft",
    "ruff",
    "pre-commit"
]
test = [
    "pytest",
]
docs = [
    "furo",
    "sphinxnotes-any",
    "sphinx_design",
    "sphinx_copybutton",
    "sphinxcontrib-gtagjs",
    "sphinxnotes-comboroles",
    "sphinxcontrib.asciinema",
]

[project.urls]
homepage = "https://sphinx.silverrainz.me/snippet"
documentation = "https://sphinx.silverrainz.me/snippet"
repository = "https://github.com/sphinx-notes/snippet"
changelog = "https://sphinx.silverrainz.me/snippet/changelog.html"
tracker = "https://github.com/sphinx-notes/snippet/issues"

[project.scripts]
snippet = "sphinxnotes.snippet.cli:main"

[build-system]
requires = ["setuptools>=46.1.0", "setuptools_scm[toml]>=5", "wheel"]
build-backend = "setuptools.build_meta"

[tool.setuptools_scm]
# For smarter version schemes and other configuration options,
# check out https://github.com/pypa/setuptools_scm
version_scheme = "no-guess-dev"

[tool.setuptools.packages.find]
# Find namespace package,
# check out https://setuptools.pypa.io/en/latest/userguide/package_discovery.html#finding-namespace-packages
where = ["src"]

[tool.setuptools.package-data]
# A maps from PACKAGE NAMES to lists of glob patterns,
# see also https://setuptools.pypa.io/en/latest/userguide/datafiles.html
"sphinxnotes.snippet.integration" = ["*.*"]