diff --git a/docs/README.rst b/docs/README.rst index 08b97d8..417f003 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -1,5 +1,6 @@ -swh-py-template -=============== +.. _swh-py-template: -Python module template, used as skeleton to create new modules. +Software Heritage - Python module template +========================================== +Python module template, used as skeleton to create new modules. diff --git a/docs/index.rst b/docs/index.rst index e3f72ed..7466a62 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,20 +1,13 @@ -.. _swh-py-template: - -Software Heritage - Python module template -========================================== - -Python module template, used as skeleton to create new modules. - .. include:: README.rst .. toctree:: :maxdepth: 2 :caption: Contents: Indices and tables -================== +------------------ * :ref:`genindex` * :ref:`modindex` * :ref:`search` diff --git a/setup.py b/setup.py index a4eba4b..853d297 100755 --- a/setup.py +++ b/setup.py @@ -1,75 +1,75 @@ #!/usr/bin/env python3 # Copyright (C) 2019-2021 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information from io import open from os import path from setuptools import find_packages, setup here = path.abspath(path.dirname(__file__)) # Get the long description from the README file with open(path.join(here, "README.rst"), encoding="utf-8") as f: long_description = f.read() def parse_requirements(*names): requirements = [] for name in names: if name: reqf = "requirements-%s.txt" % name else: reqf = "requirements.txt" if not path.exists(reqf): return requirements with open(reqf) as f: for line in f.readlines(): line = line.strip() if not line or line.startswith("#"): continue requirements.append(line) return requirements # Edit this part to match your module. # Full sample: # https://forge.softwareheritage.org/diffusion/DCORE/browse/master/setup.py setup( name="swh.", # example: swh.loader.pypi description="Software Heritage ", long_description=long_description, - long_description_content_type="text/markdown", + long_description_content_type="text/x-rst", python_requires=">=3.7", author="Software Heritage developers", author_email="swh-devel@inria.fr", url="https://forge.softwareheritage.org/diffusion/", packages=find_packages(), # packages's modules install_requires=parse_requirements(None, "swh"), tests_require=parse_requirements("test"), setup_requires=["setuptools-scm"], use_scm_version=True, extras_require={"testing": parse_requirements("test")}, include_package_data=True, entry_points=""" [swh.cli.subcommands] =swh..cli """, classifiers=[ "Programming Language :: Python :: 3", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Operating System :: OS Independent", "Development Status :: 3 - Alpha", ], project_urls={ "Bug Reports": "https://forge.softwareheritage.org/maniphest", "Funding": "https://www.softwareheritage.org/donate", "Source": "https://forge.softwareheritage.org/source/swh-", "Documentation": "https://docs.softwareheritage.org/devel/swh-/", }, )