Fix some documentation generation errors and fix index page in docs.

- Added the correct config in `setup.cfg` to run `python setup.py build_sphinx`
  to build the documentation.
- Fixed some whitespace errors in news.rst
- Index page in documentation now just includes the README.rst, which makes it
  render correctly in PyPI as well as Readthedocs.
- Change URLs to point to docs.mailman3.org for installation.
parent 3c944687
......@@ -45,25 +45,11 @@ The minimum Django version is 1.11.
Postorius needs a running version of GNU Mailman version 3.2
NEWS/Changelog
==============
News and the changelog can be found in the package documentation:
src/postorius/doc/news.rst
Installation
============
To install GNU Mailman follow the instructions in the documentation:
http://mailman.readthedocs.org/
A description how to run Postorius on Django's dev server or deploying it
using Apache/mod_wsgi or Nginx/uwsig, can be found in the package documentation:
src/postorius/doc/setup.rst
src/postorius/doc/deployment.rst
To install GNU Mailman Suite follow the instructions in the documentation:
http://docs.mailman3.org/
Acknowledgements
......
[build_sphinx]
source_dir: src/postorius/doc/
Postorius - The New Mailman Web UI
==================================
Copyright (C) 2009-2018 by the Free Software Foundation, Inc.
This is Postorius, the new official web interface for the GNU Mailman 3
list management system.
.. include:: ../../../README.rst
Table of Contents
-----------------
......
......@@ -41,6 +41,7 @@ along with Postorius. If not, see <http://www.gnu.org/licenses/>.
1.2.2
=====
(2018-08-30)
* Add support for Python 3.7 with Django 2.0+
* Index page only shows related lists for signed-in users with option to
filter based on role.
......@@ -102,7 +103,7 @@ along with Postorius. If not, see <http://www.gnu.org/licenses/>.
* Postorius now sets the 'Display Name' of the user in Core correctly. This
fixes a security vulnerability where user's display_name would be set as their
Core's password.
=======
1.1.1
=====
......@@ -148,7 +149,7 @@ along with Postorius. If not, see <http://www.gnu.org/licenses/>.
(2015-04-28)
* Help texts Small visual alignment fix; removed unnecessary links to
separate help pages.
separate help pages.
* Import fix in fieldset_forms module (Django1.6 only)
......@@ -170,7 +171,7 @@ separate help pages.
* Mozilla Persona integration: switch from django-social-auto to django-browserid: Contributed by Abhilash Raj.
* Fix manage.py mmclient command for non-IPython shells. Contributed by Ankush Sharma (LP: 1428169).
* Added archiver options: Site-wide enabled archivers can not be enabled
on a per-list basis through the web UI.
on a per-list basis through the web UI.
* Added functionality to choose or switch subscription addresses. Contributed by Abhilash Raj.
* Added subscription moderation, pre_verification/_confirmation.
* Several style changes.
......
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