From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Subject: [PATCH 1/3] doc: reorganize sphinx toctree
Date: Fri, 1 Jul 2022 06:58:58 -0300 [thread overview]
Message-ID: <20220701095900.18133-2-david@tethera.net> (raw)
In-Reply-To: <20220701095900.18133-1-david@tethera.net>
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 <man1/notmuch-git>
+ notmuch-setup <man1/notmuch>
+
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
--
2.35.2
next prev parent reply other threads:[~2022-07-01 9:59 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-01 9:58 improve html docs David Bremner
2022-07-01 9:58 ` David Bremner [this message]
2022-07-15 16:41 ` [PATCH 1/3] doc: reorganize sphinx toctree David Bremner
2022-07-01 9:58 ` [PATCH 2/3] doc: retitle notmuch-emacs manual David Bremner
2022-07-01 9:59 ` [PATCH 3/3] doc: drop module index from ToC David Bremner
2022-07-01 10:58 ` [PATCH 4/4] doc: do not generate python module index David Bremner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220701095900.18133-2-david@tethera.net \
--to=david@tethera.net \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).