Commit 5f0cb0c9 authored by Abhilash Raj's avatar Abhilash Raj

Merge branch 'autodoc' into 'master'

Fix metadata and README.rst so that it renders on PyPI.

See merge request mailman/mailmanclient!89
parents cb960d7d 6e7354a5
Pipeline #44871112 passed with stage
in 4 minutes and 57 seconds
......@@ -46,7 +46,7 @@ Documentation
A `simple guide`_ to using the library is available within this package, in
the form of doctests. The manual is also available online at:
http://mailmanclient.readthedocs.org/en/latest/
https://mailmanclient.readthedocs.io/en/latest/
Project details
......@@ -85,15 +85,5 @@ Many thanks to Florian Fuchs for his contribution of an initial REST
client. Also thanks to all the contributors of Mailman Client who have
contributed code, raised issues or devoted their time in any capacity!
.. toctree::
:maxdepth: 2
:caption: Table of Contents
src/mailmanclient/docs/NEWS.rst
src/mailmanclient/docs/using.rst
src/mailmanclient/docs/apiref.rst
src/mailmanclient/docs/testing.rst
.. _`simple guide`: https://mailmanclient.readthedocs.io/en/latest/using.html
.. _`Cheese Shop`: https://pypi.python.org/pypi/mailmanclient
.. _`simple guide`: https://mailmanclient.readthedocs.io/en/latest/src/mailmanclient/docs/using.html
.. _`Cheese Shop`: https://pypi.org/project/mailmanclient
......@@ -43,11 +43,11 @@ source_suffix = '.rst'
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'README'
master_doc = 'index'
# General information about the project.
project = u'Mailman Client'
copyright = u'2012-2017, The Free Software Foundation'
copyright = u'2012-2019, The Free Software Foundation'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
......
.. include:: README.rst
Contents
========
.. toctree::
:glob:
:maxdepth: 2
src/mailmanclient/docs/*
[build_sphinx]
source_dir: mailman/client
source_dir: .
[upload_docs]
upload_dir: build/sphinx/html
......@@ -23,18 +23,24 @@ require_python(0x30500f0)
__version__ = get_version('src/mailmanclient/constants.py')
def readme():
with open('README.rst') as fd:
return fd.read()
setup(
name='mailmanclient',
version=__version__,
packages=find_packages('src'),
description='mailmanclient -- Python bindings for Mailman REST API',
long_description=open('README.rst').read(),
long_description=readme(),
long_description_content_type='text/x-rst',
package_dir={'': 'src'},
include_package_data=True,
maintainer='Barry Warsaw',
maintainer_email='[email protected]',
license='LGPLv3',
url='https://www.list.org/',
url='http://www.list.org/',
classifiers=[
'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)', # noqa
'Operating System :: POSIX',
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment