1. Travis Shirk
  2. eyeD3

Commits

Travis Shirk  committed 18caf92

docs

  • Participants
  • Parent commits ed1d857
  • Branches stable

Comments (0)

Files changed (4)

File docs/api.rst

View file
+===
+API
+===
+
+.. toctree::
+
+    api/eyed3.rst
+    api/id3.rst
+    api/mp3.rst
+    api/plugins.rst
+    api/utils.rst

File docs/api/plugins.rst

View file
-====================
-eyed3.plugins Module
-====================
+=============
+eyed3.plugins
+=============
 
 .. automodule:: eyed3.plugins
     :members:

File docs/cli.rst

View file
 Command line options can be read from a configuration file using the
 ``-C/--config`` option. It expects a path to an
 `Ini <http://docs.python.org/2/library/configparser.html>`_ file contain
-sections with option values. For example:
+sections with option values. A sample config file, for example:
 
 .. literalinclude:: ../etc/config.ini
+   :language: ini
 
-TODO
+If the file ``${HOME}/.eyeD3/config.ini`` exists it is loaded each time eyeD3
+is run and the values take effect. This can be disabled with ``--no-config``.
 
 Custom Plugins
 --------------

File docs/index.rst

View file
     :maxdepth: 2
 
     cli
+    api
+
+.. toctree::
+    :hidden:
+
     changelog
 
 .. _api-index:
 
-API
-===
-
-.. toctree::
-
-    api/eyed3.rst
-    api/id3.rst
-    api/mp3.rst
-    api/plugins.rst
-    api/utils.rst
-
 
 ChangeLog
 =========