]> git.cworth.org Git - notmuch/commitdiff
doc: reorganize sphinx toctree
authorDavid Bremner <david@tethera.net>
Thu, 30 Jun 2022 12:00:43 +0000 (09:00 -0300)
committerDavid Bremner <david@tethera.net>
Thu, 14 Jul 2022 20:31:11 +0000 (16:31 -0400)
This mainly affects the html output (although users generating epub or
pdf would also notice a change). The goal is twofold: make the TOC a
bit friendler and easier to navigate by introducing some hierarchy,
and allow links for nmbug and notmuch-setup.

doc/command-line.rst [new file with mode: 0644]
doc/index.rst
doc/queries.rst [new file with mode: 0644]

diff --git a/doc/command-line.rst b/doc/command-line.rst
new file mode 100644 (file)
index 0000000..543a5f9
--- /dev/null
@@ -0,0 +1,36 @@
+Notmuch Command Line Interface
+==============================
+
+Main commands
+-------------
+
+.. toctree::
+   :titlesonly:
+
+   man1/notmuch
+   man1/notmuch-address
+   man1/notmuch-compact
+   man1/notmuch-config
+   man1/notmuch-count
+   man1/notmuch-dump
+   man1/notmuch-emacs-mua
+   man1/notmuch-git
+   man1/notmuch-insert
+   man1/notmuch-new
+   man1/notmuch-reindex
+   man1/notmuch-reply
+   man1/notmuch-restore
+   man1/notmuch-search
+   man1/notmuch-show
+   man1/notmuch-tag
+   man5/notmuch-hooks
+
+Aliases
+-------
+  
+.. toctree::
+   :titlesonly:
+
+   nmbug <man1/notmuch-git>
+   notmuch-setup <man1/notmuch>
+   
index c380ee1dd5d56153899dfb2f727f08cf572b684e..6b84a15ff3f42de547007fccd5e034cfc16932a1 100644 (file)
@@ -2,34 +2,17 @@
 Welcome to notmuch's documentation!
 ===================================
 
-Contents:
+Content
+-------
 
 .. toctree::
    :titlesonly:
 
-   man1/notmuch
-   man1/notmuch-address
-   man1/notmuch-compact
-   man1/notmuch-config
-   man1/notmuch-count
-   man1/notmuch-dump
+   command-line
+   queries
    notmuch-emacs
-   man1/notmuch-emacs-mua
-   man1/notmuch-git
-   man5/notmuch-hooks
-   man1/notmuch-insert
-   man1/notmuch-new
-   man7/notmuch-properties
-   man1/notmuch-reindex
-   man1/notmuch-reply
-   man1/notmuch-restore
-   man1/notmuch-search
-   man7/notmuch-search-terms
-   man7/notmuch-sexp-queries
-   man1/notmuch-show
-   man1/notmuch-tag
    python-bindings
-
+   
 Indices and tables
 ==================
 
diff --git a/doc/queries.rst b/doc/queries.rst
new file mode 100644 (file)
index 0000000..b76e71e
--- /dev/null
@@ -0,0 +1,9 @@
+Notmuch Queries
+===============
+
+.. toctree::
+   :titlesonly:
+
+   man7/notmuch-search-terms
+   man7/notmuch-sexp-queries
+   man7/notmuch-properties