pyproject.toml

[project]
name = "atsphinx-toybox"
version = "2025.1.21"
description = "Miscellaneous sphinx-extension collection of attakei' trials."
authors = [{name = "Kazuya Takei", email = "myself@attakei.net"}]
license = "Apache-2.0"
requires-python = ">= 3.9"
classifiers = [
    "Development Status :: 3 - Alpha",
    "Framework :: Sphinx",
    "Framework :: Sphinx :: Extension",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: Apache Software License",
    "Operating System :: OS Independent",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Topic :: Documentation",
    "Topic :: Documentation :: Sphinx",
    "Topic :: Software Development",
    "Topic :: Software Development :: Documentation",
    "Topic :: Software Development :: Libraries",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Topic :: Text Processing",
    "Topic :: Text Processing :: Markup",
    "Topic :: Text Processing :: Markup :: reStructuredText",
]
readme = "README.rst"
dependencies = [
    "atsphinx-bulma>=0.2.0",
    "sphinx",
]

[project.urls]
Home = "https://github.com/atsphinx/toybox"
Documentation = "https://atsphinx.github.io/toybox"

[project.optional-dependencies]
sass = [
    "httpx>=0.28.0",
]
lindera-search = [
    "lindera-py>=0.38.4",
]

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

[tool.uv]
managed = true
dev-dependencies = [
    "atsphinx-goto-top>=0.1.1",
    "atsphinx-mini18n",
    "doc8",
    "esbonio",
    "mypy",
    "pytest",
    "sphinx-autobuild",
    "sphinx-intl",
    "sphinx-toolbox>=3.8.1",
]

[tool.ruff.lint]
select = ["C90", "D", "E", "F", "I", "W"]

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

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

[tool.hatch.build.targets.wheel]
packages = ["src/atsphinx"]
only-includes = ["src/atsphinx"]

[tool.mypy]
exclude = 'conf\.py$'

[[tool.mypy.overrides]]
module = ['docutils', 'docutils.*', 'lindera_py']
ignore_missing_imports = true

[tool.sphinx-build.docs]
# -- Project information
project = "atsphinx-toybox"
copyright = "2024, Kazuya Takei"
author = "Kazuya Takei"
release = "2025.1.21"

# -- General configuration
extensions = [
    # Bundled extensions
    "sphinx.ext.githubpages",
    "sphinx.ext.intersphinx",
    "sphinx.ext.todo",
    # Third-party extensions
    "atsphinx.goto_top",
    "atsphinx.mini18n",
    "sphinx_toolbox.confval",
    # My extensions
    "atsphinx.toybox.sass",
    "atsphinx.toybox.stlite",
]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "node_modules"]
templates_path = ["_templates"]

# -- Options for i18n
gettext_compact = false
locale_dirs = ["_locales"]

# -- Options for HTML output
html_theme = "bulma-basic"
html_static_path = ["_static"]
html_title = "atsphinx-toybox v2025.1.21"
html_css_files = [
    "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/fontawesome.min.css",
    "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/solid.min.css",
    "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/brands.min.css",
    "css/demo.css",
]

# -- Options for extensions
intersphinx_mapping = { sphinx = ["https://www.sphinx-doc.org/en/master", {}] }
# sphinx.ext.intersphinx
# sphinx.ext.todo
todo_include_todos = true
# atsphinx.goto_top
goto_top_design = "image"
goto_top_side = "left"
# atsphinx.mini18n
mini18n_default_language = "en"
mini18n_support_languages = ["en", "ja"]
mini18n_basepath = "/toybox/"
# atsphinx.toybox.sass
sass_load_paths = ["./node_modules"]
sass_extra_options = ["--update", "-q"]

[tool.sphinx-build.docs.html_theme_options]
navbar_icons = [
    { name = "GitHub", url = "https://github.com/atsphinx/toybox/", html = "", class = "fa-brands fa-solid fa-github fa-2x" },
]
[tool.sphinx-build.docs.html_sidebars]
"**" = [
    "select-lang.html",
    "sidebar/searchbox.html",
    "sidebar/localtoc.html",
]