Barry Warsaw pushed to branch master at mailman / Mailman
Commits:
711e2d20 by Abhilash Raj at 2016-08-21T12:02:11-07:00
Reorganize the documentation for better accesibility
- - - - -
11 changed files:
- README.rst
- + src/mailman/app/docs/app.rst
- + src/mailman/chains/docs/chains.rst
- + src/mailman/commands/docs/commands.rst
- + src/mailman/core/docs/core.rst
- + src/mailman/handlers/docs/handlers.rst
- + src/mailman/model/docs/model.rst
- + src/mailman/mta/docs/mta.rst
- + src/mailman/rest/docs/rest.rst
- src/mailman/rules/docs/rules.rst
- + src/mailman/runners/docs/runners.rst
Changes:
=====================================
README.rst
=====================================
--- a/README.rst
+++ b/README.rst
@@ -46,14 +46,15 @@ Table of Contents
:glob:
src/mailman/docs/INTRODUCTION
- src/mailman/docs/CONTRIBUTE
- src/mailman/docs/ARCHITECTURE
src/mailman/docs/RELEASENOTES
src/mailman/docs/DATABASE
src/mailman/docs/MTA
- src/mailman/docs/8-miles-high
src/mailman/docs/WebUIin5
src/mailman/docs/ArchiveUIin5
+ src/mailman/docs/CONTRIBUTE
+ src/mailman/docs/STYLEGUIDE
+ src/mailman/docs/ARCHITECTURE
+ src/mailman/docs/8-miles-high
Mailman modules
@@ -62,24 +63,24 @@ Mailman modules
These documents are generated from the doctest suite.
.. toctree::
- :glob:
-
- src/mailman/model/docs/*
- src/mailman/runners/docs/*
- src/mailman/chains/docs/*
- src/mailman/rules/docs/*
- src/mailman/handlers/docs/*
- src/mailman/rest/docs/*
- src/mailman/core/docs/*
- src/mailman/app/docs/*
- src/mailman/styles/docs/*
- src/mailman/archiving/docs/*
- src/mailman/mta/docs/*
- src/mailman/bin/docs/*
- src/mailman/commands/docs/*
+ :maxdepth: 1
+
+ src/mailman/model/docs/model
+ src/mailman/runners/docs/runners
+ src/mailman/chains/docs/chains
+ src/mailman/rules/docs/rules
+ src/mailman/handlers/docs/handlers
+ src/mailman/rest/docs/rest
+ src/mailman/core/docs/core
+ src/mailman/app/docs/app
+ src/mailman/styles/docs/styles
+ src/mailman/archiving/docs/common
+ src/mailman/mta/docs/mta
+ src/mailman/bin/docs/master
+ src/mailman/commands/docs/commands
src/mailman/docs/NEWS
- src/mailman/docs/STYLEGUIDE
src/mailman/docs/ACKNOWLEDGMENTS
+ contrib/README
Indices and tables
=====================================
src/mailman/app/docs/app.rst
=====================================
--- /dev/null
+++ b/src/mailman/app/docs/app.rst
@@ -0,0 +1,8 @@
+===
+App
+===
+
+.. toctree::
+ :glob:
+
+ ./*
=====================================
src/mailman/chains/docs/chains.rst
=====================================
--- /dev/null
+++ b/src/mailman/chains/docs/chains.rst
@@ -0,0 +1,8 @@
+======
+Chains
+======
+
+.. toctree::
+ :glob:
+
+ ./*
=====================================
src/mailman/commands/docs/commands.rst
=====================================
--- /dev/null
+++ b/src/mailman/commands/docs/commands.rst
@@ -0,0 +1,8 @@
+========
+Commands
+========
+
+.. toctree::
+ :glob:
+
+ ./*
=====================================
src/mailman/core/docs/core.rst
=====================================
--- /dev/null
+++ b/src/mailman/core/docs/core.rst
@@ -0,0 +1,9 @@
+====
+Core
+====
+
+.. toctree::
+ :glob:
+
+ ./*
+
=====================================
src/mailman/handlers/docs/handlers.rst
=====================================
--- /dev/null
+++ b/src/mailman/handlers/docs/handlers.rst
@@ -0,0 +1,8 @@
+========
+Handlers
+========
+
+.. toctree::
+ :glob:
+
+ ./*
=====================================
src/mailman/model/docs/model.rst
=====================================
--- /dev/null
+++ b/src/mailman/model/docs/model.rst
@@ -0,0 +1,8 @@
+======
+Models
+======
+
+.. toctree::
+ :glob:
+
+ ./*
=====================================
src/mailman/mta/docs/mta.rst
=====================================
--- /dev/null
+++ b/src/mailman/mta/docs/mta.rst
@@ -0,0 +1,8 @@
+=====================
+Mail Transport Agents
+=====================
+
+.. toctree::
+ :glob:
+
+ ./*
=====================================
src/mailman/rest/docs/rest.rst
=====================================
--- /dev/null
+++ b/src/mailman/rest/docs/rest.rst
@@ -0,0 +1,8 @@
+========
+REST API
+========
+
+.. toctree::
+ :glob:
+
+ ./*
=====================================
src/mailman/rules/docs/rules.rst
=====================================
--- a/src/mailman/rules/docs/rules.rst
+++ b/src/mailman/rules/docs/rules.rst
@@ -68,3 +68,8 @@ list administrator.
True
>>> rule.check(mlist, msg, dict(moderator_approved=True))
False
+
+.. toctree::
+ :glob:
+
+ ./*
=====================================
src/mailman/runners/docs/runners.rst
=====================================
--- /dev/null
+++ b/src/mailman/runners/docs/runners.rst
@@ -0,0 +1,8 @@
+=======
+Runners
+=======
+
+.. toctree::
+ :glob:
+
+ ./*
View it on GitLab:
https://gitlab.com/mailman/mailman/commit/711e2d20617ab85959a2446d610a860bdc306a54
_______________________________________________
Mailman-checkins mailing list
Mailman-checkins@python.org
Unsubscribe:
https://mail.python.org/mailman/options/mailman-checkins/archive%40jab.org
