← Back to branch summary

~prakash09/mailman/3.0

« back to all changes in this revision

Viewing changes to README.rst

  • Committer: Barry Warsaw
  • Date: 2011-09-24 02:29:10 UTC
  • mto: This revision was merged to the branch mainline in revision 7054.
  • Revision ID: barry@list.org-20110924022910-vqmxkgjbf0padro0
This is the way to build the documentation now:

$ python setup.py build_sphinx

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.rst
6
6
 
7
7
This is GNU Mailman, a mailing list management system distributed under the
8
8
terms of the GNU General Public License (GPL) version 3 or later.  The name of
9
 
this software is spelled "Mailman" with a leading capital `M' but with a lower
10
 
case second `m'.  Any other spelling is incorrect.
 
9
this software is spelled "Mailman" with a leading capital 'M' but with a lower
 
10
case second 'm'.  Any other spelling is incorrect.
11
11
 
12
12
Mailman is written in Python which is available for all platforms that Mailman
13
13
is supported on, including GNU/Linux and most other Unix-like operating
14
 
systems (e.g. Solaris, *BSD, MacOSX, etc.).  Mailman is not supported on
 
14
systems (e.g. Solaris, \*BSD, MacOSX, etc.).  Mailman is not supported on
15
15
Windows, although web and mail clients on any platform should be able to
16
16
interact with Mailman just fine.
17
17
 
25
25
 
26
26
For more information on Mailman, see the above web sites, or the documentation
27
27
provided with this software.  Start at src/mailman/docs/README.txt.
 
28
 
 
29
 
 
30
Table of Contents
 
31
=================
 
32
 
 
33
.. toctree::
 
34
    :glob:
 
35
 
 
36
    src/mailman/docs/INTRODUCTION
 
37
    src/mailman/docs/START
 
38
    src/mailman/docs/MTA
 
39
    src/mailman/bin/docs/*
 
40
    src/mailman/commands/docs/*
 
41
    src/mailman/model/docs/*
 
42
    src/mailman/core/docs/*
 
43
    src/mailman/app/docs/*
 
44
    src/mailman/runners/docs/*
 
45
    src/mailman/pipeline/docs/*
 
46
    src/mailman/rest/docs/*
 
47
    src/mailman/chains/docs/*
 
48
    src/mailman/rules/docs/*
 
49
    src/mailman/archiving/docs/*
 
50
    src/mailman/mta/docs/*
 
51
    src/mailman/docs/NEWS
 
52
    src/mailman/docs/STYLEGUIDE
 
53
    src/mailman/docs/ACKNOWLEDGMENTS
 
54
 
 
55
 
 
56
Indices and tables
 
57
==================
 
58
 
 
59
* :ref:`genindex`
 
60
* :ref:`modindex`
 
61
* :ref:`search`