From 5d55312fdb67ce406f663ea8fc0c8636ac5c5e87 Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Sun, 16 Feb 2014 19:25:26 -0800 Subject: [PATCH] add TOCs to some documentation --- docs/reference/cli.rst | 16 ++++++++++++++-- docs/reference/config.rst | 10 ++++++++++ 2 files changed, 24 insertions(+), 2 deletions(-) diff --git a/docs/reference/cli.rst b/docs/reference/cli.rst index a287d33f4..c44ec3a02 100644 --- a/docs/reference/cli.rst +++ b/docs/reference/cli.rst @@ -19,11 +19,21 @@ Command-Line Interface The rest of this document describes the available commands. If you ever need a quick list of what's available, just type ``beet help`` or ``beet help - COMMAND`` or help with a specific command. + COMMAND`` for help with a specific command. Commands -------- +.. only:: html + + Here are the built-in commands available in beets: + + .. contents:: + :local: + :depth: 1 + + Also be sure to see the :ref:`global flags `. + .. _import-cmd: import @@ -294,11 +304,13 @@ fields Show the item and album metadata fields available for use in :doc:`query` and :doc:`pathformat`. Includes any template fields provided by plugins. +.. _global-flags: + Global Flags ------------ Beets has a few "global" flags that affect all commands. These must appear -between the executable name (``beet``) and the command: for example, ``beet -v +between the executable name (``beet``) and the command---for example, ``beet -v import ...``. * ``-l LIBPATH``: specify the library database file to use. diff --git a/docs/reference/config.rst b/docs/reference/config.rst index 31dc9fd9b..92b3135cb 100644 --- a/docs/reference/config.rst +++ b/docs/reference/config.rst @@ -33,6 +33,14 @@ documentation. .. _YAML: http://yaml.org/ +The rest of this page enumerates the dizzying litany of configuration options +available in beets. You might also want to see an +:ref:`example `. + +.. contents:: + :local: + :depth: 2 + Global Options -------------- @@ -546,6 +554,8 @@ fact, just shorthand for the explicit queries ``singleton:true`` and ``comp:true``. In contrast, ``default`` is special and has no query equivalent: the ``default`` format is only used if no queries match. +.. _config-example: + Example -------