From a2da24fc7120df835022642ca7297b1a24404873 Mon Sep 17 00:00:00 2001 From: Rolf Krahl Date: Sat, 2 Dec 2023 20:12:42 +0100 Subject: [PATCH] Add an outline for the module reference --- doc/src/mod-archive.rst | 5 +++++ doc/src/mod-bt.rst | 8 +++++++ doc/src/mod-cli.rst | 8 +++++++ doc/src/mod-config.rst | 5 +++++ doc/src/mod-exception.rst | 5 +++++ doc/src/mod-index.rst | 5 +++++ doc/src/mod-mailarchive.rst | 5 +++++ doc/src/mod-manifest.rst | 5 +++++ doc/src/mod-tools.rst | 5 +++++ doc/src/moduleref.rst | 42 +++++++++++++++++++++++++++++++++++-- 10 files changed, 91 insertions(+), 2 deletions(-) create mode 100644 doc/src/mod-archive.rst create mode 100644 doc/src/mod-bt.rst create mode 100644 doc/src/mod-cli.rst create mode 100644 doc/src/mod-config.rst create mode 100644 doc/src/mod-exception.rst create mode 100644 doc/src/mod-index.rst create mode 100644 doc/src/mod-mailarchive.rst create mode 100644 doc/src/mod-manifest.rst create mode 100644 doc/src/mod-tools.rst diff --git a/doc/src/mod-archive.rst b/doc/src/mod-archive.rst new file mode 100644 index 0000000..a24a6b4 --- /dev/null +++ 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 new file mode 100644 index 0000000..5744129 --- /dev/null +++ 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 new file mode 100644 index 0000000..d516ffb --- /dev/null +++ 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 new file mode 100644 index 0000000..dc9d2f6 --- /dev/null +++ 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 new file mode 100644 index 0000000..e44aaf8 --- /dev/null +++ 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 new file mode 100644 index 0000000..8f8585f --- /dev/null +++ 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 new file mode 100644 index 0000000..324c533 --- /dev/null +++ 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 new file mode 100644 index 0000000..5b913ff --- /dev/null +++ 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 new file mode 100644 index 0000000..d5afacb --- /dev/null +++ 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 index 14675b6..14c9035 100644 --- 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