plone-sphinx-theme/pyproject.toml at main · plone/plone-sphinx-theme · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
[project]
name = "plone-sphinx-theme"
description = "Plone Sphinx Theme is the official Sphinx theme for Plone 6 Documentation, Plone Conference Training, and documentation of various Plone packages."
keywords = [
  "Plone",
  "Sphinx",
  "Theme",
  "documentation",
  "training",
  "Diátaxis",
]
dynamic = ["version"]
readme = "README.md"
requires-python = ">=3.10,<3.14"
license = { file = "LICENSE" }
maintainers = [
  { name = "Steve Piercy", email = "spiercy@plone.org" },
]
authors = [
  { name = "Steve Piercy", email = "spiercy@plone.org" },
]
classifiers = [
  "Development Status :: 5 - Production/Stable",
  "Framework :: Sphinx",
  "Framework :: Sphinx :: Theme",
  "License :: OSI Approved :: GNU General Public License v2 (GPLv2)",
  "Operating System :: OS Independent",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
]

dependencies = [
  # Stable pins, see https://github.com/plone/plone-sphinx-theme/issues/42
  "myst-parser",
#  "pydata-sphinx-theme==0.15.4",
#  "sphinx>=7.4.7,<9",
  "sphinx-book-theme==1.1.4",
]

[project.optional-dependencies]
#code_style = [
#    "pre-commit"
#]
[dependency-groups]
dev = [
    "graphviz>=0.20.3",
    "linkify-it-py>=2.0.3",
    "sphinx-autobuild>=2024.10.3",
    "sphinx-copybutton>=0.5.2",
    "sphinx-design>=0.6.1",
    "sphinx-examples>=0.0.5",
    "sphinx-notfound-page>=1.1.0",
    "sphinx-reredirects>=0.1.5",
    "sphinx-sitemap>=2.6.0",
    "sphinx-theme-builder[cli]>=0.2.0b2",
    "sphinx-tippy>=0.4.3",
    "sphinxcontrib-httpdomain>=1.8.1",
    "sphinxcontrib-httpexample>=1.3",
    "sphinxcontrib-mermaid>=1.0.0",
    "sphinxcontrib-video>=0.4.1",
    "sphinxcontrib-youtube>=1.4.1",
    "sphinxext-opengraph>=0.9.1",
    "vale>=3.9.5.0",
    "zest-releaser[recommended]>=9.4.0",
    "zestreleaser-towncrier>=1.3.0",
]

[project.entry-points]
"sphinx.html_themes" = { plone_sphinx_theme = "plone_sphinx_theme" }

[project.urls]
Documentation = "https://plone-sphinx-theme.readthedocs.io/"
Repository = "https://github.com/plone/plone-sphinx-theme"
Issues = "https://github.com/plone/plone-sphinx-theme/issues"
Changelog = "https://github.com/plone/plone-sphinx-theme/blob/main/CHANGES.md"
Sponsor = "https://github.com/sponsors/plone"
Discord = "https://discord.com/channels/786421998426521600/862642144401031188"
Mastodon = "https://plone.social/@plone"
YouTube = "https://www.youtube.com/@plonecms"

[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"

[tool.sphinx-theme-builder]
node-version = "16.13.2"
theme-name = "plone-sphinx-theme"

#[tool.pytest.ini_options]
#testpaths = [
#    "tests"
#]
#filterwarnings = [
#]

[tool.zest-releaser]
python-file-with-version = "src/plone_sphinx_theme/__init__.py"

[tool.towncrier]
directory = "news/"
filename = "CHANGES.md"
issue_format = "[Issue #{issue}](https://github.com/plone/plone-sphinx-theme/issues/{issue})"
start_string = "<!-- towncrier release notes start -->\n"
template = "scripts/templates/towncrier_template.jinja"
title_format = "## {version} ({project_date})"
# First underline is used for version/date header.
# Second underline is used for the type names (like 'Bug fixes:').
underlines = ["", "", ""]

[[tool.towncrier.type]]
directory = "internal"
name = "Internal changes"
showcontent = true

[[tool.towncrier.type]]
directory = "breaking"
name = "Breaking changes"
showcontent = true

[[tool.towncrier.type]]
directory = "feature"
name = "New features"
showcontent = true

[[tool.towncrier.type]]
directory = "bugfix"
name = "Bug fixes"
showcontent = true

[[tool.towncrier.type]]
directory = "documentation"
name = "Documentation"
showcontent = true

[tool.setuptools.dynamic]
version = {attr = "plone_sphinx_theme.__version__"}