From b55650d91f991eaf2e6cae8022a6ed4219255bb3 Mon Sep 17 00:00:00 2001 From: Barry Warsaw Date: Fri, 23 Sep 2011 22:29:10 -0400 Subject: This is the way to build the documentation now: $ python setup.py build_sphinx --- src/mailman/__init__.py | 13 ++-- src/mailman/docs/ACKNOWLEDGMENTS.rst | 22 +++++-- src/mailman/docs/INTRODUCTION.rst | 93 ++++++++++++++++++++++++++++ src/mailman/docs/README.rst | 117 ----------------------------------- 4 files changed, 119 insertions(+), 126 deletions(-) create mode 100644 src/mailman/docs/INTRODUCTION.rst delete mode 100644 src/mailman/docs/README.rst (limited to 'src') diff --git a/src/mailman/__init__.py b/src/mailman/__init__.py index ed51320ba..2c34e0971 100644 --- a/src/mailman/__init__.py +++ b/src/mailman/__init__.py @@ -41,8 +41,11 @@ except ImportError: # however, we'll initialize it differently for tests. We have to do it this # early so that module contents is set up before anything that needs it is # imported. -if sys.argv[0].split(os.sep)[-1] == 'test': - from mailman.testing.i18n import initialize -else: - from mailman.core.i18n import initialize -initialize() +# +# Do *not* do this if we're building the documentation. +if 'build_sphinx' not in sys.argv: + if sys.argv[0].split(os.sep)[-1] == 'test': + from mailman.testing.i18n import initialize + else: + from mailman.core.i18n import initialize + initialize() diff --git a/src/mailman/docs/ACKNOWLEDGMENTS.rst b/src/mailman/docs/ACKNOWLEDGMENTS.rst index bb971a91d..36a386b57 100644 --- a/src/mailman/docs/ACKNOWLEDGMENTS.rst +++ b/src/mailman/docs/ACKNOWLEDGMENTS.rst @@ -37,20 +37,34 @@ Here is the list of other contributors who have donated large bits of code, and have assigned copyright for contributions to the FSF: * Juan Carlos Rey Anaya +* Andrija Arsic * Richard Barrett +* Jimmy Bergman * Stephan Berndts * Norbert Bollow +* Joe Dugan +* Ethan Mindlace Fremen +* Florian Fuchs * Ben Gertzfield * Victoriano Giralt +* Stephen Goss * Mads Kiilerich +* Cedric Knight +* Patrick Ben Koetter * The Dragon De Monsyne * Les Niles +* Reed O'Brien * Terri Oda * Simone Piunno +* Claudia Schmidt +* Andreas Schosser +* Richard Wackerbarth + +Special Thanks +============== -Other Thanks -============ +Very special thanks to Andrija Arsic for his winning new GNU Mailman logos. Thanks also go to the following people for their important contributions in other aspects of the Mailman project: @@ -59,7 +73,7 @@ other aspects of the Mailman project: * JC Dill * Clytie Siddall -Thanks also to Dragon for his winning Mailman logo contribution, and to Terri +Thanks also to Dragon for his original Mailman logo contribution, and to Terri Oda for the neat shortcut icon and the member documentation. Control.com sponsored development of several Mailman 2.1 features, including @@ -68,7 +82,7 @@ support. My thanks especially to Dan Pierson and Ken Crater from Control.com. Here is the list of other people who have contributed useful ideas, suggestions, bug fixes, testing, etc., or who have been very helpful in -answering questions on mailman-users. Please let me know if anybody's been +answering questions on mailman-users. Please let me know if you have been left off the list! * David Abrahams diff --git a/src/mailman/docs/INTRODUCTION.rst b/src/mailman/docs/INTRODUCTION.rst new file mode 100644 index 000000000..e67439613 --- /dev/null +++ b/src/mailman/docs/INTRODUCTION.rst @@ -0,0 +1,93 @@ +================================================ +Mailman - The GNU Mailing List Management System +================================================ + +This is `GNU Mailman`_, a mailing list management system distributed under the +terms of the `GNU General Public License`_ (GPL) version 3 or later. + +Mailman is written in Python_, a free object-oriented programming language. +Python is available for all platforms that Mailman is supported on, which +includes GNU/Linux and most other Unix-like operating systems (e.g. Solaris, +\*BSD, MacOSX, etc.). Mailman is not supported on Windows, although web and +mail clients on any platform should be able to interact with Mailman just +fine. + +Learn more about GNU Mailman in the `Getting Started`_ documentation. + + +Copyright +========= + +Copyright 1998-2011 by the Free Software Foundation, Inc. + +This file is part of GNU Mailman. + +GNU Mailman is free software: you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free Software +Foundation, either version 3 of the License, or (at your option) any later +version. + +GNU Mailman is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR +A PARTICULAR PURPOSE. See the GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along with +GNU Mailman. If not, see . + + +Spelling +======== + +The name of this software is spelled `Mailman` with a leading capital `M` +but with a lower case second `m`. Any other spelling is incorrect. Its full +name is `GNU Mailman` but is often referred colloquially as `Mailman`. + + +History +======= + +Mailman was originally developed by John Viega. Subsequent development +(through version 1.0b3) was by Ken Manheimer. Further work towards the 1.0 +final release was a group effort, with the core contributors being: Barry +Warsaw, Ken Manheimer, Scott Cotton, Harald Meland, and John Viega. Version +1.0 and beyond have been primarily maintained by Barry Warsaw with +contributions from many; see the ACKNOWLEDGMENTS file for details. Jeremy +Hylton helped considerably with the Pipermail code in Mailman 2.0. Mailman +2.1 is primarily maintained by Mark Sapiro and Tokio Kikuchi. Barry Warsaw is +the lead developer on Mailman 3. + + +Help +==== + +The Mailman home page is: + + http://www.list.org + +with mirrors at: + + * http://www.gnu.org/software/mailman + * http://mailman.sf.net + +The community driven wiki (including the FAQ_) is at: + + http://wiki.list.org + +Other help resources, such as on-line documentation, links to the mailing +lists and archives, etc., are available at: + + http://www.list.org/help.html + + +Requirements +============ + +Mailman 3.0 requires `Python 2.6`_ or newer. + + +.. _`GNU Mailman`: http://www.list.org +.. _`GNU General Public License`: http://www.gnu.org/licenses/gpl.txt +.. _`Getting Started`: START.html +.. _Python: http://www.python.org +.. _FAQ: http://wiki.list.org/display/DOC/Frequently+Asked+Questions +.. _`Python 2.6`: http://www.python.org/download/releases/2.6.6/ diff --git a/src/mailman/docs/README.rst b/src/mailman/docs/README.rst deleted file mode 100644 index b7a247de4..000000000 --- a/src/mailman/docs/README.rst +++ /dev/null @@ -1,117 +0,0 @@ -================================================ -Mailman - The GNU Mailing List Management System -================================================ - -This is `GNU Mailman`_, a mailing list management system distributed under the -terms of the `GNU General Public License`_ (GPL) version 3 or later. - -Mailman is written in Python_, a free object-oriented programming language. -Python is available for all platforms that Mailman is supported on, which -includes GNU/Linux and most other Unix-like operating systems (e.g. Solaris, -\*BSD, MacOSX, etc.). Mailman is not supported on Windows, although web and -mail clients on any platform should be able to interact with Mailman just -fine. - -Learn more about GNU Mailman in the `Getting Started`_ documentation. - - -Copyright -========= - -Copyright 1998-2011 by the Free Software Foundation, Inc. - -This file is part of GNU Mailman. - -GNU Mailman is free software: you can redistribute it and/or modify it under -the terms of the GNU General Public License as published by the Free Software -Foundation, either version 3 of the License, or (at your option) any later -version. - -GNU Mailman is distributed in the hope that it will be useful, but WITHOUT ANY -WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR -A PARTICULAR PURPOSE. See the GNU General Public License for more details. - -You should have received a copy of the GNU General Public License along with -GNU Mailman. If not, see . - - -Spelling -======== - -The name of this software is spelled `Mailman` with a leading capital `M` -but with a lower case second `m`. Any other spelling is incorrect. Its full -name is `GNU Mailman` but is often referred colloquially as `Mailman`. - - -History -======= - -Mailman was originally developed by John Viega. Subsequent development -(through version 1.0b3) was by Ken Manheimer. Further work towards the 1.0 -final release was a group effort, with the core contributors being: Barry -Warsaw, Ken Manheimer, Scott Cotton, Harald Meland, and John Viega. Version -1.0 and beyond have been primarily maintained by Barry Warsaw with -contributions from many; see the ACKNOWLEDGMENTS file for details. Jeremy -Hylton helped considerably with the Pipermail code in Mailman 2.0. Mailman -2.1 is primarily maintained by Mark Sapiro and Tokio Kikuchi. Barry Warsaw is -the lead developer on Mailman 3. - - -Help -==== - -The Mailman home page is: - - http://www.list.org - -with mirrors at: - - * http://www.gnu.org/software/mailman - * http://mailman.sf.net - -The community driven wiki (including the FAQ_) is at: - - http://wiki.list.org - -Other help resources, such as on-line documentation, links to the mailing -lists and archives, etc., are available at: - - http://www.list.org/help.html - - -Requirements -============ - -Mailman 3.0 requires `Python 2.6`_ or newer. - - -.. _`GNU Mailman`: http://www.list.org -.. _`GNU General Public License`: http://www.gnu.org/licenses/gpl.txt -.. _`Getting Started`: START.html -.. _Python: http://www.python.org -.. _FAQ: http://wiki.list.org/display/DOC/Frequently+Asked+Questions -.. _`Python 2.6`: http://www.python.org/download/releases/2.6.6/ - - -Table of Contents -================= - -.. toctree:: - :glob: - - START - MTA - NEWS - STYLEGUIDE - ACKNOWLEDGMENTS - ../bin/docs/* - ../commands/docs/* - ../model/docs/* - ../app/docs/* - ../pipeline/docs/* - ../queue/docs/* - ../rest/docs/* - ../chains/docs/* - ../rules/docs/* - ../archiving/docs/* - ../mta/docs/* -- cgit v1.2.3-70-g09d2