pyproject.toml

[build-system]
requires = ["setuptools>=61.0", "wheel", "setuptools_scm>=6.2"]
build-backend = "setuptools.build_meta"

[tool.setuptools_scm]

[project]
name = "great-docs"
dynamic = ["version"]
description = "An easy-to-use documentation site generator for Python packages"
readme = "README.md"
license = {file = "LICENSE"}
authors = [
    {name = "Rich Iannone", email = "riannone@me.com"}
]
maintainers = [
    {name = "Rich Iannone", email = "riannone@me.com"}
]
keywords = ["documentation", "documentation-generator", "api-documentation", "quarto", "python"]
classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: MIT License",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Topic :: Documentation",
    "Topic :: Software Development :: Documentation",
    "Topic :: Text Processing :: Markup :: HTML",
]
requires-python = ">=3.11"
dependencies = [
    "ipykernel>=6.0",
    "nbclient>=0.10",
    "py-yaml12>=0.2.0",
    "PyYAML>=6.0",
    "click>=8.0.0",
    "griffe~=2.1.0",
    "requests>=2.25.0",
    "python-dotenv>=1.0.0",
    "Pillow>=9.0.0",
    "ruff>=0.9.9",
]

[project.optional-dependencies]
svg = [
    "cairosvg>=2.5.0",
]
mcp = [
    "mcp>=1.0.0",
]
marimo = [
    "marimo>=0.20.0",
    # marimo's `export html-wasm` (iframe mode) shells out to uv to resolve the
    # notebook's inline (PEP 723) dependencies.
    "uv>=0.5.0",
]
dev = [
    "pytest>=6.0",
    "pytest-cov>=3.0",
    "pytest-xdist>=3.5",
    # Validates termshow files against their published JSON Schemas
    "jsonschema>=4.18",
    # Generates the signature grammar. The committed grammar must match this
    # version; bump it and run `make signature-grammar` together.
    "pygments==2.21.0",
    "ruff>=0.9.9",
    "mypy>=1.0.0",
    "pyright>=1.1.414",
    "build>=0.7",
    "twine>=3.4",
    "typer>=0.12.0",
    "great-docs[docs]",
]
docs = [
    "plotnine>=0.13.0",
    "jupyter>=1.0.0",
    "polars>=0.20",
    "pandas>=2.0",
    "pyarrow>=12.0",
    "great_tables>=1.1.0",
    "great-docs[mcp,marimo]",
]


[project.urls]
Homepage = "https://github.com/posit-dev/great-docs"
Repository = "https://github.com/posit-dev/great-docs"
Documentation = "https://posit-dev.github.io/great-docs/"
"Bug Tracker" = "https://github.com/posit-dev/great-docs/issues"

[project.scripts]
great-docs = "great_docs.cli:main"

[tool.setuptools.packages.find]
where = ["."]
include = ["great_docs*"]

[tool.setuptools.package-data]
great_docs = ["assets/*", "assets/.*", "_term_player/schemas/*.json"]

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

[tool.pytest.ini_options]
testpaths = ["tests"]
python_files = ["test_*.py", "*_test.py"]
python_classes = ["Test*"]
python_functions = ["test_*"]
addopts = [
    "--strict-markers",
    "--strict-config",
]
markers = [
    "dedicated: test targets one or more specific gdtest_* packages (not a generic sweep)",
]

[tool.coverage.run]
source = ["great_docs"]
omit = [
    "*/tests/*",
    "*/test_*.py",
    "*/__pycache__/*",
    "*/site-packages/*",
]
branch = true

[tool.coverage.report]
precision = 2
show_missing = true
skip_covered = false
exclude_lines = [
    "pragma: no cover",
    "def __repr__",
    "raise AssertionError",
    "raise NotImplementedError",
    "if __name__ == .__main__.:",
    "if TYPE_CHECKING:",
    "@abstractmethod",
]

[tool.ruff]
line-length = 100
target-version = "py311"

[tool.ruff.lint]
exclude = ["docs", ".venv", "tests/*", "build/*", "dist/*"]

# Select rule sets
select = [
    "E",   # pycodestyle errors
    "W",   # pycodestyle warnings
    "F",   # pyflakes
    "I",   # isort (import sorting)
]

ignore = [
    "E402",  # module level import not at top of file
    "E501",  # line too long (handled by formatter)
    "F811",  # redefinition of unused name
    "E203",  # whitespace before ':'
    "F841",  # local variable assigned but never used
    "E702",  # multiple statements on one line (semicolon)
]

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
line-ending = "auto"

[tool.ruff.lint.per-file-ignores]
"__init__.py" = ["F401", "E402"]
"tests/*" = ["F401", "E402"]

[tool.pyright]
pythonVersion = "3.11"
typeCheckingMode = "strict"
include = [
    "great_docs/_apiref",
    "great_docs/_build",
    "great_docs/_builtin",
    "great_docs/_git.py",
    "great_docs/_icons.py",
    "great_docs/_interlinks",
    "great_docs/_layout.py",
    "great_docs/_layout_migration",
    "great_docs/_layout_notice.py",
    "great_docs/_mcp_runner.py",
    "great_docs/_source_refs.py",
    "great_docs/_subprocess.py",
    "great_docs/_translations.py",
    "great_docs/_typer_cli.py",
    "great_docs/_website",
    "great_docs/_yaml.py",
    "great_docs/config.py",
    "great_docs/contrast.py",
    "great_docs/hooks",
    "great_docs/pandoc",
]
exclude = [
    "**/__pycache__",
    "**/node_modules",
    "**/.venv",
    "**/build",
    "**/dist",
    "tests",
    "docs",
]
reportMissingImports = true
reportMissingTypeStubs = false
reportUnusedImport = true
reportUnusedVariable = true
# Additional strict checks from renderer
reportUnnecessaryTypeIgnoreComment = true
reportCallInDefaultInitializer = true
reportPropertyTypeMismatch = true
reportUnusedCallResult = true

[tool.mypy]
python_version = "3.11"
strict = true
warn_return_any = true
warn_unused_configs = true
disallow_untyped_defs = true
disallow_incomplete_defs = true
check_untyped_defs = true
no_implicit_optional = true
warn_redundant_casts = true
warn_unused_ignores = true
exclude = [
    "tests/",
    "docs/",
    "build/",
    "dist/",
]

[[tool.mypy.overrides]]
module = [
    "yaml.*",
    "griffe.*",
]
ignore_missing_imports = true