summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.rst37
-rw-r--r--src/mailman/app/docs/app.rst8
-rw-r--r--src/mailman/chains/docs/chains.rst8
-rw-r--r--src/mailman/commands/docs/commands.rst8
-rw-r--r--src/mailman/core/docs/core.rst9
-rw-r--r--src/mailman/handlers/docs/handlers.rst8
-rw-r--r--src/mailman/model/docs/model.rst8
-rw-r--r--src/mailman/mta/docs/mta.rst8
-rw-r--r--src/mailman/rest/docs/rest.rst8
-rw-r--r--src/mailman/rules/docs/rules.rst5
-rw-r--r--src/mailman/runners/docs/runners.rst8
11 files changed, 97 insertions, 18 deletions
diff --git a/README.rst b/README.rst
index 77bcdc703..772285c0a 100644
--- 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:
+ :maxdepth: 1
- 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/*
+ 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
diff --git a/src/mailman/app/docs/app.rst b/src/mailman/app/docs/app.rst
new file mode 100644
index 000000000..96182e4ad
--- /dev/null
+++ b/src/mailman/app/docs/app.rst
@@ -0,0 +1,8 @@
+===
+App
+===
+
+.. toctree::
+ :glob:
+
+ ./*
diff --git a/src/mailman/chains/docs/chains.rst b/src/mailman/chains/docs/chains.rst
new file mode 100644
index 000000000..7eea10606
--- /dev/null
+++ b/src/mailman/chains/docs/chains.rst
@@ -0,0 +1,8 @@
+======
+Chains
+======
+
+.. toctree::
+ :glob:
+
+ ./*
diff --git a/src/mailman/commands/docs/commands.rst b/src/mailman/commands/docs/commands.rst
new file mode 100644
index 000000000..eb0c0fee6
--- /dev/null
+++ b/src/mailman/commands/docs/commands.rst
@@ -0,0 +1,8 @@
+========
+Commands
+========
+
+.. toctree::
+ :glob:
+
+ ./*
diff --git a/src/mailman/core/docs/core.rst b/src/mailman/core/docs/core.rst
new file mode 100644
index 000000000..e4f5d9940
--- /dev/null
+++ b/src/mailman/core/docs/core.rst
@@ -0,0 +1,9 @@
+====
+Core
+====
+
+.. toctree::
+ :glob:
+
+ ./*
+
diff --git a/src/mailman/handlers/docs/handlers.rst b/src/mailman/handlers/docs/handlers.rst
new file mode 100644
index 000000000..dbc412ce6
--- /dev/null
+++ b/src/mailman/handlers/docs/handlers.rst
@@ -0,0 +1,8 @@
+========
+Handlers
+========
+
+.. toctree::
+ :glob:
+
+ ./*
diff --git a/src/mailman/model/docs/model.rst b/src/mailman/model/docs/model.rst
new file mode 100644
index 000000000..68df5da67
--- /dev/null
+++ b/src/mailman/model/docs/model.rst
@@ -0,0 +1,8 @@
+======
+Models
+======
+
+.. toctree::
+ :glob:
+
+ ./*
diff --git a/src/mailman/mta/docs/mta.rst b/src/mailman/mta/docs/mta.rst
new file mode 100644
index 000000000..eb4f0463e
--- /dev/null
+++ b/src/mailman/mta/docs/mta.rst
@@ -0,0 +1,8 @@
+=====================
+Mail Transport Agents
+=====================
+
+.. toctree::
+ :glob:
+
+ ./*
diff --git a/src/mailman/rest/docs/rest.rst b/src/mailman/rest/docs/rest.rst
new file mode 100644
index 000000000..8461e641d
--- /dev/null
+++ b/src/mailman/rest/docs/rest.rst
@@ -0,0 +1,8 @@
+========
+REST API
+========
+
+.. toctree::
+ :glob:
+
+ ./*
diff --git a/src/mailman/rules/docs/rules.rst b/src/mailman/rules/docs/rules.rst
index e2ff747b9..f82167a55 100644
--- 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:
+
+ ./*
diff --git a/src/mailman/runners/docs/runners.rst b/src/mailman/runners/docs/runners.rst
new file mode 100644
index 000000000..60a48cad1
--- /dev/null
+++ b/src/mailman/runners/docs/runners.rst
@@ -0,0 +1,8 @@
+=======
+Runners
+=======
+
+.. toctree::
+ :glob:
+
+ ./*