Add an outline for the module reference

RKrahl · Dec 2, 2023 · a2da24f · a2da24f
1 parent 2bba2f0
commit a2da24f
Show file tree

Hide file tree

Showing 10 changed files with 91 additions and 2 deletions.
diff --git a/doc/src/mod-archive.rst b/doc/src/mod-archive.rst
@@ -0,0 +1,5 @@
+:mod:`archive.archive` --- Provide the Archive class
+====================================================
+
+.. automodule:: archive.archive
+   :members:
diff --git a/doc/src/mod-bt.rst b/doc/src/mod-bt.rst
@@ -0,0 +1,8 @@
+:mod:`archive.bt` --- Implement backup-tool
+===========================================
+
+.. note::
+   This package and its submodules implement the :ref:`backup-tool`
+   command line script.  They are not intended to be used in other
+   Python programs and not considered to be part of the archive-tool
+   API.
diff --git a/doc/src/mod-cli.rst b/doc/src/mod-cli.rst
@@ -0,0 +1,8 @@
+:mod:`archive.cli` --- Implement archive-tool
+=============================================
+
+.. note::
+   This package and its submodules implement the :ref:`archive-tool`
+   command line script.  They are not intended to be used in other
+   Python programs and not considered to be part of the archive-tool
+   API.
diff --git a/doc/src/mod-config.rst b/doc/src/mod-config.rst
@@ -0,0 +1,5 @@
+:mod:`archive.config` --- Manage configuration
+==============================================
+
+.. automodule:: archive.config
+   :members:
diff --git a/doc/src/mod-exception.rst b/doc/src/mod-exception.rst
@@ -0,0 +1,5 @@
+:mod:`archive.exception` --- Exception handling
+===============================================
+
+.. automodule:: archive.exception
+   :members:
diff --git a/doc/src/mod-index.rst b/doc/src/mod-index.rst
@@ -0,0 +1,5 @@
+:mod:`archive.index` --- Represent an index of archives
+=======================================================
+
+.. automodule:: archive.index
+   :members:
diff --git a/doc/src/mod-mailarchive.rst b/doc/src/mod-mailarchive.rst
@@ -0,0 +1,5 @@
+:mod:`archive.mailarchive` --- Provide the MailArchive class
+============================================================
+
+.. automodule:: archive.mailarchive
+   :members:
diff --git a/doc/src/mod-manifest.rst b/doc/src/mod-manifest.rst
@@ -0,0 +1,5 @@
+:mod:`archive.manifest` --- Define the archive metadata
+=======================================================
+
+.. automodule:: archive.manifest
+   :members:
diff --git a/doc/src/mod-tools.rst b/doc/src/mod-tools.rst
@@ -0,0 +1,5 @@
+:mod:`archive.tools` --- A collection of internal helper routines
+=================================================================
+
+.. automodule:: archive.tools
+   :members:
diff --git a/doc/src/moduleref.rst b/doc/src/moduleref.rst
@@ -1,5 +1,43 @@
 Module reference
 ================
 
-..
-    provide a reference for the archive-tool modules
+This section provides a reference for the modules that implement the
+archive-tools.
+
+Modules defining the archive-tools API
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+These modules define the core of archive-tools, e.g. the classes or
+functions that implement archives.
+
+.. toctree::
+   :maxdepth: 1
+
+   mod-archive
+   mod-exception
+   mod-manifest
+
+Special purpose modules
+~~~~~~~~~~~~~~~~~~~~~~~
+
+These modules will generally be used in particular cases only.
+
+.. toctree::
+   :maxdepth: 1
+
+   mod-index
+   mod-mailarchive
+
+Internal modules
+~~~~~~~~~~~~~~~~
+
+These modules are used internally by archive-tools, but most users
+will not need to care about them.
+
+.. toctree::
+   :maxdepth: 1
+
+   mod-config
+   mod-tools
+   mod-cli
+   mod-bt