From e55b04b028c9fad03caf8ad3e3951254d5a88161 Mon Sep 17 00:00:00 2001 From: David Bremner Date: Thu, 30 Jun 2022 09:00:43 -0300 Subject: [PATCH] doc: reorganize sphinx toctree 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 | 36 ++++++++++++++++++++++++++++++++++++ doc/index.rst | 27 +++++---------------------- doc/queries.rst | 9 +++++++++ 3 files changed, 50 insertions(+), 22 deletions(-) create mode 100644 doc/command-line.rst create mode 100644 doc/queries.rst diff --git a/doc/command-line.rst b/doc/command-line.rst new file mode 100644 index 00000000..543a5f9e --- /dev/null +++ b/doc/command-line.rst @@ -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 + notmuch-setup + diff --git a/doc/index.rst b/doc/index.rst index c380ee1d..6b84a15f 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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 index 00000000..b76e71e0 --- /dev/null +++ b/doc/queries.rst @@ -0,0 +1,9 @@ +Notmuch Queries +=============== + +.. toctree:: + :titlesonly: + + man7/notmuch-search-terms + man7/notmuch-sexp-queries + man7/notmuch-properties