Skip to content

Declare project and pytest configuration in pyproject.toml #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/python-app.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:

strategy:
matrix:
python-version: ["3.6", "3.7", "3.8", "3.9"]
python-version: ["3.7", "3.8", "3.9"]
sphinx-version: [
"",
"5.0.*",
Expand Down
8 changes: 5 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,13 @@ Simply install it via ``pip``::

$ pip install autodocsumm

Or you install it via::

$ python setup.py install
Local development
^^^^^^^^^^^^^^^^^

from the `source on GitHub`_.
Use ``pip`` on the `source on GitHub`_::

$ pip install .


.. _source on GitHub: https://github.com/Chilipp/autodocsumm
Expand Down
44 changes: 44 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
[build-system]
build-backend = 'setuptools.build_meta'
requires = ['setuptools >= 61.0']

[project]
name = 'autodocsumm'
version = '0.2.8'
description = 'Extended sphinx autodoc including automatic autosummaries'
readme = 'README.rst'
keywords = ['sphinx', 'autodoc', 'autosummary', 'content', 'table']
urls.homepage = 'https://github.com/Chilipp/autodocsumm'
authors = [
{ name = 'Philipp S. Sommer', email = 'philipp.sommer@hereon.de' },
]
license = { text = 'Apache-2.0' }

classifiers = [
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Developers',
'Topic :: Documentation',
'License :: OSI Approved :: Apache Software License',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3 :: Only',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3.10',
'Operating System :: OS Independent',
]

requires-python = '>= 3.7'
dependencies = [
'Sphinx >= 2.2, < 6.0',
]

[tool.setuptools]
zip-safe = false

[tool.setuptools.packages.find]
namespaces = false
exclude = ['docs', 'tests*', 'examples']

[tool.pytest.ini_options]
addopts = '-v'
4 changes: 0 additions & 4 deletions setup.cfg

This file was deleted.

46 changes: 2 additions & 44 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,45 +1,3 @@
from setuptools import setup, find_packages
import sys
from setuptools import setup

needs_pytest = {'pytest', 'test', 'ptr'}.intersection(sys.argv)
pytest_runner = ['pytest-runner'] if needs_pytest else []


def readme():
with open('README.rst') as f:
return f.read()


setup(name='autodocsumm',
version='0.2.8',
description='Extended sphinx autodoc including automatic autosummaries',
long_description=readme(),
long_description_content_type='text/x-rst',
classifiers=[
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Developers',
'Topic :: Documentation',
'License :: OSI Approved :: Apache Software License',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3 :: Only',
'Programming Language :: Python :: 3.5',
'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',
'Operating System :: OS Independent',
],
keywords='sphinx autodoc autosummary content table',
python_requires=">=3.6",
url='https://github.com/Chilipp/autodocsumm',
author='Philipp S. Sommer',
author_email='philipp.sommer@hereon.de',
license="Apache-2.0",
packages=find_packages(exclude=['docs', 'tests*', 'examples']),
install_requires=[
'Sphinx>=2.2,<6.0',
],
setup_requires=pytest_runner,
tests_require=['pytest'],
zip_safe=False)
setup()