Merge branch '0.3.1-fix-orphans'

19 files changed, 29 insertions, 41 deletions

diff --git a/docs/source/conf.py b/docs/source/conf.py
index 24eb6a9c..dd2cccc1 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -93,7 +93,9 @@ release = version
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = []
+exclude_patterns = [
+'manpage.rst'
+]
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None
diff --git a/docs/source/configuration/accounts_table.rst b/docs/source/configuration/accounts_table
index 7ac8d90f..aea1956c 100644
--- a/docs/source/configuration/accounts_table.rst
+++ b/docs/source/configuration/accounts_table
@@ -1,6 +1,4 @@
 
-:orphan:
-
 .. CAUTION: THIS FILE IS AUTO-GENERATED
     from the inline comments of specfile defaults/alot.rc.spec.
 
diff --git a/docs/source/configuration/alotrc_table.rst b/docs/source/configuration/alotrc_table
index e8d32966..6b4e2092 100644
--- a/docs/source/configuration/alotrc_table.rst
+++ b/docs/source/configuration/alotrc_table
@@ -1,6 +1,4 @@
 
-:orphan:
-
 .. CAUTION: THIS FILE IS AUTO-GENERATED
     from the inline comments of specfile defaults/alot.rc.spec.
 
diff --git a/docs/source/configuration/index.rst b/docs/source/configuration/index.rst
index 90744ef7..b14af2e1 100644
--- a/docs/source/configuration/index.rst
+++ b/docs/source/configuration/index.rst
@@ -24,7 +24,7 @@ The type of an option is used to validate a given value. For instance,
 if the type says "boolean" you may only provide "True" or "False" as values in your config file,
 otherwise alot will complain on startup. Strings *may* be quoted but do not need to be.
 
-.. include:: alotrc_table.rst
+.. include:: alotrc_table
 
 .. _account:
 
@@ -59,7 +59,7 @@ Here is an example configuration::
 
 The following entries are interpreted at the moment:
 
-.. include:: accounts_table.rst
+.. include:: accounts_table
 
 
 Contacts Completion
@@ -151,7 +151,7 @@ Hooks are python callables that live in a module specified by `hooksfile` in the
 config. Per default this points to :file:`~/.config/alot/hooks.py`.
 When a hook gets called it receives a reference to the :class:`main user interface <alot.ui.UI>` and the
 :class:`database manager <alot.db.DBManager>`.
-For every :doc:`COMMAND <../usage/commands>` in mode :ref:`MODE <modes>`, the callables :func:`pre_MODE_COMMAND` and :func:`post_MODE_COMMAND`
+For every :ref:`COMMAND <commands>` in mode :ref:`MODE <modes>`, the callables :func:`pre_MODE_COMMAND` and :func:`post_MODE_COMMAND`
 -- if defined -- will be called before and after the command is applied respectively. The signature for the
 pre-`send` hook in envelope mode for example looks like this:
 
diff --git a/docs/source/description.rst b/docs/source/description
index fa9148d2..9dea9693 100644
--- a/docs/source/description.rst
+++ b/docs/source/description
@@ -1,5 +1,3 @@
-:orphan:
-
 Alot is a terminal-based mail user agent for the notmuch mail system.
 It features a modular and command prompt driven interface
 to provide a full MUA experience as an alternative to the Emacs mode shipped
diff --git a/docs/source/generate_commands.py b/docs/source/generate_commands.py
index 0846347e..eb241d10 100755
--- a/docs/source/generate_commands.py
+++ b/docs/source/generate_commands.py
@@ -15,7 +15,7 @@ import re as _re
 import sys as _sys
 import textwrap as _textwrap
 
-NOTE = ":orphan:\n\n.. CAUTION: THIS FILE IS AUTO-GENERATED!\n\n\n"
+NOTE = ".. CAUTION: THIS FILE IS AUTO-GENERATED!\n\n\n"
 
 class HF(HelpFormatter):
     def _metavar_formatter(self, action, default_metavar):
diff --git a/docs/source/generate_configs.py b/docs/source/generate_configs.py
index f7776ee3..8b0009e8 100755
--- a/docs/source/generate_configs.py
+++ b/docs/source/generate_configs.py
@@ -7,8 +7,6 @@ from configobj import ConfigObj
 from validate import Validator
 import re
 NOTE = """
-:orphan:
-
 .. CAUTION: THIS FILE IS AUTO-GENERATED
     from the inline comments of specfile %s.
 
@@ -62,9 +60,9 @@ if __name__ == "__main__":
     config = ConfigObj(None, configspec=specpath, stringify=False, list_values=False)
     config.validate(Validator())
 
-    alotrc_table_file = os.path.join(HERE, 'configuration', 'alotrc_table.rst')
+    alotrc_table_file = os.path.join(HERE, 'configuration', 'alotrc_table')
     rewrite_entries(config.configspec, alotrc_table_file, 'defaults/alot.rc.spec', sort=True)
 
-    rewrite_entries(config, os.path.join(HERE, 'configuration', 'accounts_table.rst'),
+    rewrite_entries(config, os.path.join(HERE, 'configuration', 'accounts_table'),
                     'defaults/alot.rc.spec',
                     sec=config.configspec['accounts']['__many__'])
diff --git a/docs/source/index.rst b/docs/source/index.rst
index cc227b77..4742e36d 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -5,7 +5,7 @@
 
 User Manual
 ===========
-.. include:: description.rst
+.. include:: description
 
 .. toctree::
    :maxdepth: 2
diff --git a/docs/source/manpage.rst b/docs/source/manpage.rst
index 6ff0624e..bfdf43da 100644
--- a/docs/source/manpage.rst
+++ b/docs/source/manpage.rst
@@ -1,21 +1,19 @@
-:orphan:
-
 Manpage
 =======
 
 Synopsis
 --------
 
-.. include:: usage/synopsis.rst
+.. include:: usage/synopsis
 
 Description
 -----------
 
-.. include:: description.rst
+.. include:: description
 
 Usage
 -----
-.. include:: usage/first_steps.rst
+.. include:: usage/first_steps
 
 
 See Also
diff --git a/docs/source/usage/commands.rst b/docs/source/usage/commands
index 9117ed18..ec0be2eb 100644
--- a/docs/source/usage/commands.rst
+++ b/docs/source/usage/commands
@@ -1,4 +1,4 @@
-:orphan:
+.. _commands:
 
 Commands
 ========
@@ -15,3 +15,15 @@ Commands
     lists all active buffers
 :doc:`modes/taglist`
     lists all tagstrings present in the notmuch database
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+
+   modes/global
+   modes/search
+   modes/thread
+   modes/envelope
+   modes/bufferlist
+   modes/taglist
+
diff --git a/docs/source/usage/first_steps.rst b/docs/source/usage/first_steps
index 7a4d275c..e99c44ce 100644
--- a/docs/source/usage/first_steps.rst
+++ b/docs/source/usage/first_steps
@@ -1,5 +1,3 @@
-:orphan:
-
 The arrow keys, `page-up/down`, `j`, `k` and `Space` can be used to move the focus.
 `Escape` cancels prompts and `Enter` selects. Hit `:` at any time and type in commands
 to the prompt.
diff --git a/docs/source/usage/index.rst b/docs/source/usage/index.rst
index 7e97e78e..4992ba1c 100644
--- a/docs/source/usage/index.rst
+++ b/docs/source/usage/index.rst
@@ -4,11 +4,11 @@ Usage
 
 Commandline invocation
 ======================
-.. include:: synopsis.rst
+.. include:: synopsis
 
 First Steps
 ===========
 
-.. include:: first_steps.rst
+.. include:: first_steps
 
-.. include:: commands.rst
+.. include:: commands
diff --git a/docs/source/usage/modes/bufferlist.rst b/docs/source/usage/modes/bufferlist.rst
index 42e596c7..3028916e 100644
--- a/docs/source/usage/modes/bufferlist.rst
+++ b/docs/source/usage/modes/bufferlist.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 .. CAUTION: THIS FILE IS AUTO-GENERATED!
 
 
diff --git a/docs/source/usage/modes/envelope.rst b/docs/source/usage/modes/envelope.rst
index ffa2ddee..3422e6e5 100644
--- a/docs/source/usage/modes/envelope.rst
+++ b/docs/source/usage/modes/envelope.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 .. CAUTION: THIS FILE IS AUTO-GENERATED!
 
 
diff --git a/docs/source/usage/modes/global.rst b/docs/source/usage/modes/global.rst
index c4364505..58ea6383 100644
--- a/docs/source/usage/modes/global.rst
+++ b/docs/source/usage/modes/global.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 .. CAUTION: THIS FILE IS AUTO-GENERATED!
 
 
diff --git a/docs/source/usage/modes/search.rst b/docs/source/usage/modes/search.rst
index f2c95cc7..16404cf4 100644
--- a/docs/source/usage/modes/search.rst
+++ b/docs/source/usage/modes/search.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 .. CAUTION: THIS FILE IS AUTO-GENERATED!
 
 
diff --git a/docs/source/usage/modes/taglist.rst b/docs/source/usage/modes/taglist.rst
index 85df5f9f..c6f7198b 100644
--- a/docs/source/usage/modes/taglist.rst
+++ b/docs/source/usage/modes/taglist.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 .. CAUTION: THIS FILE IS AUTO-GENERATED!
 
 
diff --git a/docs/source/usage/modes/thread.rst b/docs/source/usage/modes/thread.rst
index ec8ccd4f..096d7c20 100644
--- a/docs/source/usage/modes/thread.rst
+++ b/docs/source/usage/modes/thread.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 .. CAUTION: THIS FILE IS AUTO-GENERATED!
 
 
diff --git a/docs/source/usage/synopsis.rst b/docs/source/usage/synopsis
index 2e335902..5bfb8e88 100644
--- a/docs/source/usage/synopsis.rst
+++ b/docs/source/usage/synopsis
@@ -1,5 +1,3 @@
-:orphan:
-
 .. code-block:: none
 
     alot [-r] [-c CONFIGFILE] [-n NOTMUCHCONFIGFILE] [-C {1,16,256}] [-p DB_PATH]