releasing 0.21.2
[docutils.git] / docutils / pyproject.toml
blob9aea21fb41ff0d4592951c887fd25fb204851f49
1 # Project configuration file for the "docutils" package (see PEP 518)
3 # Build with flit (https://flit.pypa.io/)
4 [build-system]
5 requires = ["flit_core>=3.4,<4"]
6 build-backend = "flit_core.buildapi"
8 # Project metadata
9 # cf. https://packaging.python.org/en/latest/specifications/declaring-project-metadata/
10 [project]
12 name = "docutils"
13 dynamic = ["version"]
14 description = "Docutils -- Python Documentation Utilities"
15 readme.text = """
16 Docutils is a modular system for processing documentation
17 into useful formats, such as HTML, XML, and LaTeX.  For
18 input Docutils supports reStructuredText, an easy-to-read,
19 what-you-see-is-what-you-get plaintext markup syntax."""  # wrap at col 60
20 readme.content-type = "text/plain"
22 urls.Homepage = "https://docutils.sourceforge.io"
24 license.file = "COPYING.txt"
26 requires-python = ">=3.9"
28 # cf. https://pypi.org/trove-classifiers/
29 classifiers = [
30         'Development Status :: 4 - Beta',
31         'Environment :: Console',
32         'Intended Audience :: End Users/Desktop',
33         'Intended Audience :: Other Audience',
34         'Intended Audience :: Developers',
35         'Intended Audience :: System Administrators',
36         'License :: Public Domain',
37         'License :: OSI Approved :: Python Software Foundation License',
38         'License :: OSI Approved :: BSD License',
39         'License :: OSI Approved :: GNU General Public License (GPL)',
40         'Operating System :: OS Independent',
41         'Programming Language :: Python :: 3',
42         'Programming Language :: Python :: 3 :: Only',
43         'Programming Language :: Python :: 3.9',
44         'Programming Language :: Python :: 3.10',
45         'Programming Language :: Python :: 3.11',
46         'Topic :: Documentation',
47         'Topic :: Software Development :: Documentation',
48         'Topic :: Text Processing',
49         'Natural Language :: English',  # main/default language, keep first
50         'Natural Language :: Afrikaans',
51         'Natural Language :: Arabic',
52         'Natural Language :: Catalan',
53         'Natural Language :: Catalan (Valencian)',
54         'Natural Language :: Chinese (Simplified)',
55         'Natural Language :: Chinese (Traditional)',
56         'Natural Language :: Czech',
57         'Natural Language :: Danish',
58         'Natural Language :: Dutch',
59         'Natural Language :: Esperanto',
60         'Natural Language :: Finnish',
61         'Natural Language :: French',
62         'Natural Language :: Galician',
63         'Natural Language :: Georgian',
64         'Natural Language :: German',
65         'Natural Language :: Hebrew',
66         'Natural Language :: Italian',
67         'Natural Language :: Japanese',
68         'Natural Language :: Korean',
69         'Natural Language :: Latvian',
70         'Natural Language :: Lithuanian',
71         'Natural Language :: Persian',
72         'Natural Language :: Polish',
73         'Natural Language :: Portuguese (Brazilian)',
74         'Natural Language :: Russian',
75         'Natural Language :: Slovak',
76         'Natural Language :: Spanish',
77         'Natural Language :: Swedish',
78         'Natural Language :: Ukrainian',
81 [[project.authors]]
82 name = "David Goodger"
83 email = "goodger@python.org"
85 [[project.maintainers]]
86 name = "docutils-develop list"
87 email = "docutils-develop@lists.sourceforge.net"
89 [project.scripts]
90 docutils = "docutils.__main__:main"
91 rst2html = "docutils.core:rst2html"
92 rst2html4 = "docutils.core:rst2html4"
93 rst2html5 = "docutils.core:rst2html5"
94 rst2latex = "docutils.core:rst2latex"
95 rst2man = "docutils.core:rst2man"
96 rst2odt = "docutils.core:rst2odt"
97 rst2pseudoxml = "docutils.core:rst2pseudoxml"
98 rst2s5 = "docutils.core:rst2s5"
99 rst2xetex = "docutils.core:rst2xetex"
100 rst2xml = "docutils.core:rst2xml"
103 # Sdist (*.tar.gz) generation
104 [tool.flit.sdist]
106 # required as ``flit --use-vcs`` only works for git and hg (current default)
107 # TODO: include generated HTML ?
108 include = [
109     "*.txt",
110     "docutils/",
111     "docs/",
112     "licenses/",
113     "test/",
114     "tools/",
117 # TODO: Recursive globbing (**) is not supported yet (in exclude pattern '**/*~')
118 exclude = [
119     "*~",
120     "*/*~",
121     "*.DS_Store",
122     "*/*.DS_Store",
123     "*/.pytest_cache",
124     "test/alltests.out",
125     "test/functional/output/[a-z]*",
126     "test/record.txt",
129 # Codespell configuration (see https://pypi.org/project/codespell/)
130 [tool.codespell]
131 skip = [
132     "test",
133     "pep-*.txt",
134     "iso*.txt",
136 ignore-words-list = [
137     "ba",
138     "complies",
139     "ede",
140     "fo",
141     "hist",
142     "ist",
143     "ment",
144     "nd",
145     "ned",
146     "ninjs",
147     "ownward",
148     "ream",
149     "ro",
150     "shttp",
151     "ta",
152     "te",
153     "ue",
154     "wee",
155     "windos",