Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Move to pyproject.toml metadata - Update references to `setup.py` - Use pypa/build - Update workflows and tooling
- Loading branch information
Showing
11 changed files
with
185 additions
and
207 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -74,7 +74,7 @@ covertest: | |
|
||
.PHONY: build | ||
build: | ||
@$(PYTHON) setup.py build | ||
@$(PYTHON) -m build . | ||
|
||
.PHONY: docs | ||
docs: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,123 +1,135 @@ | ||
from setuptools import find_packages, setup | ||
[build-system] | ||
requires = ["flit_core>=3.7"] | ||
build-backend = "flit_core.buildapi" | ||
|
||
import sphinx | ||
# project metadata | ||
[project] | ||
name = "Sphinx" | ||
description = "Python documentation generator" | ||
readme = "README.rst" | ||
urls.Changelog = "https://www.sphinx-doc.org/en/master/changes.html" | ||
urls.Code = "https://github.com/sphinx-doc/sphinx" | ||
urls.Download = "https://pypi.org/project/Sphinx/" | ||
urls.Homepage = "https://www.sphinx-doc.org/" | ||
urls."Issue tracker" = "https://github.com/sphinx-doc/sphinx/issues" | ||
license.text = "BSD" | ||
requires-python = ">=3.6" | ||
|
||
with open('README.rst', encoding='utf-8') as f: | ||
long_desc = f.read() | ||
# Classifiers list: https://pypi.org/classifiers/ | ||
classifiers = [ | ||
"Development Status :: 5 - Production/Stable", | ||
"Environment :: Console", | ||
"Environment :: Web Environment", | ||
"Intended Audience :: Developers", | ||
"Intended Audience :: Education", | ||
"Intended Audience :: End Users/Desktop", | ||
"Intended Audience :: Science/Research", | ||
"Intended Audience :: System Administrators", | ||
"License :: OSI Approved :: BSD License", | ||
"Operating System :: OS Independent", | ||
"Programming Language :: Python", | ||
"Programming Language :: Python :: 3", | ||
"Programming Language :: Python :: 3 :: Only", | ||
"Programming Language :: Python :: 3.6", | ||
"Programming Language :: Python :: 3.7", | ||
"Programming Language :: Python :: 3.8", | ||
"Programming Language :: Python :: 3.9", | ||
"Programming Language :: Python :: 3.10", | ||
"Programming Language :: Python :: Implementation :: CPython", | ||
"Programming Language :: Python :: Implementation :: PyPy", | ||
"Framework :: Setuptools Plugin", | ||
"Framework :: Sphinx", | ||
"Framework :: Sphinx :: Extension", | ||
"Framework :: Sphinx :: Theme", | ||
"Topic :: Documentation", | ||
"Topic :: Documentation :: Sphinx", | ||
"Topic :: Internet :: WWW/HTTP :: Site Management", | ||
"Topic :: Printing", | ||
"Topic :: Software Development", | ||
"Topic :: Software Development :: Documentation", | ||
"Topic :: Text Processing", | ||
"Topic :: Text Processing :: General", | ||
"Topic :: Text Processing :: Indexing", | ||
"Topic :: Text Processing :: Markup", | ||
"Topic :: Text Processing :: Markup :: HTML", | ||
"Topic :: Text Processing :: Markup :: LaTeX", | ||
"Topic :: Utilities", | ||
] | ||
dependencies = [ | ||
"sphinxcontrib-applehelp", | ||
"sphinxcontrib-devhelp", | ||
"sphinxcontrib-jsmath", | ||
"sphinxcontrib-htmlhelp>=2.0.0", | ||
"sphinxcontrib-serializinghtml>=1.1.5", | ||
"sphinxcontrib-qthelp", | ||
"Jinja2>=3.0", | ||
"Pygments>=2.12", | ||
"docutils>=0.14,<0.20", | ||
"snowballstemmer>=2.0", | ||
"babel>=2.9", | ||
"alabaster>=0.7,<0.8", | ||
"imagesize>=1.3", | ||
"requests>=2.5.0", | ||
"packaging>=21.0", | ||
"importlib-metadata>=4.8; python_version < '3.10'", | ||
"colorama>=0.4.5; sys_platform == 'win32'", | ||
] | ||
dynamic = ["version"] | ||
|
||
setup( | ||
name='Sphinx', | ||
version=sphinx.__version__, | ||
url='https://www.sphinx-doc.org/', | ||
download_url='https://pypi.org/project/Sphinx/', | ||
license='BSD', | ||
author='Georg Brandl', | ||
author_email='georg@python.org', | ||
description='Python documentation generator', | ||
long_description=long_desc, | ||
long_description_content_type='text/x-rst', | ||
project_urls={ | ||
"Code": "https://github.com/sphinx-doc/sphinx", | ||
"Changelog": "https://www.sphinx-doc.org/en/master/changes.html", | ||
"Issue tracker": "https://github.com/sphinx-doc/sphinx/issues", | ||
}, | ||
zip_safe=False, | ||
classifiers=[ | ||
'Development Status :: 5 - Production/Stable', | ||
'Environment :: Console', | ||
'Environment :: Web Environment', | ||
'Intended Audience :: Developers', | ||
'Intended Audience :: Education', | ||
'Intended Audience :: End Users/Desktop', | ||
'Intended Audience :: Science/Research', | ||
'Intended Audience :: System Administrators', | ||
'License :: OSI Approved :: BSD License', | ||
'Operating System :: OS Independent', | ||
'Programming Language :: Python', | ||
'Programming Language :: Python :: 3', | ||
'Programming Language :: Python :: 3 :: Only', | ||
'Programming Language :: Python :: 3.6', | ||
'Programming Language :: Python :: 3.7', | ||
'Programming Language :: Python :: 3.8', | ||
'Programming Language :: Python :: 3.9', | ||
'Programming Language :: Python :: 3.10', | ||
'Programming Language :: Python :: Implementation :: CPython', | ||
'Programming Language :: Python :: Implementation :: PyPy', | ||
'Framework :: Setuptools Plugin', | ||
'Framework :: Sphinx', | ||
'Framework :: Sphinx :: Extension', | ||
'Framework :: Sphinx :: Theme', | ||
'Topic :: Documentation', | ||
'Topic :: Documentation :: Sphinx', | ||
'Topic :: Internet :: WWW/HTTP :: Site Management', | ||
'Topic :: Printing', | ||
'Topic :: Software Development', | ||
'Topic :: Software Development :: Documentation', | ||
'Topic :: Text Processing', | ||
'Topic :: Text Processing :: General', | ||
'Topic :: Text Processing :: Indexing', | ||
'Topic :: Text Processing :: Markup', | ||
'Topic :: Text Processing :: Markup :: HTML', | ||
'Topic :: Text Processing :: Markup :: LaTeX', | ||
'Topic :: Utilities', | ||
], | ||
platforms='any', | ||
packages=find_packages(exclude=['tests', 'utils']), | ||
package_data = { | ||
'sphinx': ['py.typed'], | ||
}, | ||
include_package_data=True, | ||
entry_points={ | ||
'console_scripts': [ | ||
'sphinx-build = sphinx.cmd.build:main', | ||
'sphinx-quickstart = sphinx.cmd.quickstart:main', | ||
'sphinx-apidoc = sphinx.ext.apidoc:main', | ||
'sphinx-autogen = sphinx.ext.autosummary.generate:main', | ||
], | ||
'distutils.commands': [ | ||
'build_sphinx = sphinx.setup_command:BuildDoc', | ||
], | ||
}, | ||
python_requires=">=3.6", | ||
install_requires=[ | ||
'sphinxcontrib-applehelp', | ||
'sphinxcontrib-devhelp', | ||
'sphinxcontrib-jsmath', | ||
'sphinxcontrib-htmlhelp>=2.0.0', | ||
'sphinxcontrib-serializinghtml>=1.1.5', | ||
'sphinxcontrib-qthelp', | ||
'Jinja2>=3.0', | ||
'Pygments>=2.12', | ||
'docutils>=0.14,<0.20', | ||
'snowballstemmer>=2.0', | ||
'babel>=2.9', | ||
'alabaster>=0.7,<0.8', | ||
'imagesize>=1.3', | ||
'requests>=2.5.0', | ||
'packaging>=21.0', | ||
"importlib-metadata>=4.8; python_version < '3.10'", | ||
"colorama>=0.4.5; sys_platform == 'win32'", | ||
], | ||
extras_require={ | ||
'docs': [ | ||
'sphinxcontrib-websupport', | ||
], | ||
'lint': [ | ||
'flake8>=3.5.0', | ||
'flake8-comprehensions', | ||
'flake8-bugbear', | ||
'isort', | ||
'mypy>=0.971', | ||
'sphinx-lint', | ||
'docutils-stubs', | ||
"types-typed-ast", | ||
"types-requests", | ||
], | ||
'test': [ | ||
'pytest>=4.6', | ||
'html5lib', | ||
"typed_ast; python_version < '3.8'", | ||
'cython', | ||
], | ||
}, | ||
) | ||
[project.optional-dependencies] | ||
docs = [ | ||
"sphinxcontrib-websupport", | ||
] | ||
lint = [ | ||
"flake8>=3.5.0", | ||
"flake8-comprehensions", | ||
"flake8-bugbear", | ||
"isort", | ||
"mypy>=0.971", | ||
"sphinx-lint", | ||
"docutils-stubs", | ||
"types-typed-ast", | ||
"types-requests", | ||
] | ||
test = [ | ||
"pytest>=4.6", | ||
"html5lib", | ||
"typed_ast; python_version < '3.8'", | ||
"cython", | ||
] | ||
|
||
[[project.authors]] | ||
name = "Georg Brandl" | ||
email = "georg@python.org" | ||
|
||
[project.scripts] | ||
sphinx-build = "sphinx.cmd.build:main" | ||
sphinx-quickstart = "sphinx.cmd.quickstart:main" | ||
sphinx-apidoc = "sphinx.ext.apidoc:main" | ||
sphinx-autogen = "sphinx.ext.autosummary.generate:main" | ||
|
||
[project.entry-points."distutils.commands"] | ||
build_sphinx = 'sphinx.setup_command:BuildDoc' | ||
|
||
[tool.flit.module] | ||
name = "sphinx" | ||
|
||
[tool.flit.sdist] | ||
include = [ | ||
"LICENSE", | ||
"AUTHORS", | ||
"CHANGES", | ||
# Documentation | ||
"doc/", | ||
"CODE_OF_CONDUCT", # used as an include in the Documentation | ||
"EXAMPLES", # used as an include in the Documentation | ||
# Tests | ||
"tests/", | ||
"tox.ini", | ||
# Utilities | ||
"utils/", | ||
"babel.cfg", | ||
] | ||
exclude = [ | ||
"doc/_build", | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.