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.
This commit is contained in:
David Bremner 2022-06-30 09:00:43 -03:00
parent 7925481997
commit e55b04b028
3 changed files with 50 additions and 22 deletions

36
doc/command-line.rst Normal file
View file

@ -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>

View file

@ -2,32 +2,15 @@
Welcome to notmuch's documentation! Welcome to notmuch's documentation!
=================================== ===================================
Contents: Content
-------
.. toctree:: .. toctree::
:titlesonly: :titlesonly:
man1/notmuch command-line
man1/notmuch-address queries
man1/notmuch-compact
man1/notmuch-config
man1/notmuch-count
man1/notmuch-dump
notmuch-emacs 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 python-bindings
Indices and tables Indices and tables

9
doc/queries.rst Normal file
View file

@ -0,0 +1,9 @@
Notmuch Queries
===============
.. toctree::
:titlesonly:
man7/notmuch-search-terms
man7/notmuch-sexp-queries
man7/notmuch-properties