Commits

Travis Shirk  committed 2d5d46c

use sphinx-apidoc, etc.

  • Participants
  • Parent commits 03ee2b4
  • Branches stable

Comments (0)

Files changed (13)

File docs/api.rst

-===
-API
-===
-
-.. toctree::
-
-    api/eyed3.rst
-    api/id3.rst
-    api/mp3.rst
-    api/plugins.rst
-    api/utils.rst

File docs/api/eyed3.id3.rst

+id3 Package
+===========
+
+:mod:`id3` Package
+------------------
+
+.. automodule:: eyed3.id3
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`frames` Module
+--------------------
+
+.. automodule:: eyed3.id3.frames
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`headers` Module
+---------------------
+
+.. automodule:: eyed3.id3.headers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`tag` Module
+-----------------
+
+.. automodule:: eyed3.id3.tag
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

File docs/api/eyed3.mp3.rst

+mp3 Package
+===========
+
+:mod:`mp3` Package
+------------------
+
+.. automodule:: eyed3.mp3
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`headers` Module
+---------------------
+
+.. automodule:: eyed3.mp3.headers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

File docs/api/eyed3.plugins.rst

+plugins Package
+===============
+
+:mod:`plugins` Package
+----------------------
+
+.. automodule:: eyed3.plugins
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`classic` Module
+---------------------
+
+.. automodule:: eyed3.plugins.classic
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`examples` Module
+----------------------
+
+.. automodule:: eyed3.plugins.examples
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`lameinfo` Module
+----------------------
+
+.. automodule:: eyed3.plugins.lameinfo
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`nfo` Module
+-----------------
+
+.. automodule:: eyed3.plugins.nfo
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`statistics` Module
+------------------------
+
+.. automodule:: eyed3.plugins.statistics
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`xep_118` Module
+---------------------
+
+.. automodule:: eyed3.plugins.xep_118
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

File docs/api/eyed3.rst

-=====
-eyed3
-=====
+eyed3 Package
+=============
 
-.. automodule:: eyed3
+:mod:`eyed3` Package
+--------------------
+
+.. automodule:: eyed3.__init__
     :members:
     :undoc-members:
+    :show-inheritance:
+
+:mod:`core` Module
+------------------
+
+.. automodule:: eyed3.core
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`info` Module
+------------------
+
+.. automodule:: eyed3.info
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`main` Module
+------------------
+
+.. automodule:: eyed3.main
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    eyed3.id3
+    eyed3.mp3
+    eyed3.plugins
+    eyed3.utils
+

File docs/api/eyed3.utils.rst

+utils Package
+=============
+
+:mod:`utils` Package
+--------------------
+
+.. automodule:: eyed3.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`binfuncs` Module
+----------------------
+
+.. automodule:: eyed3.utils.binfuncs
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`cli` Module
+-----------------
+
+.. automodule:: eyed3.utils.cli
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`log` Module
+-----------------
+
+.. automodule:: eyed3.utils.log
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

File docs/api/id3.rst

-=========
-eyed3.id3
-=========
-
-.. automodule:: eyed3.id3
-    :members:
-    :undoc-members:
-
-eyed3.id3.tag
-=============
-
-.. automodule:: eyed3.id3.tag
-    :members:
-    :undoc-members:
-
-eyed3.id3.headers
-=================
-
-.. automodule:: eyed3.id3.headers
-    :members:
-    :undoc-members:
-

File docs/api/modules.rst

+eyed3
+=====
+
+.. toctree::
+   :maxdepth: 4
+
+   eyed3

File docs/api/mp3.rst

-
-=========
-eyed3.mp3
-=========
-
-.. automodule:: eyed3.mp3
-    :members:
-    :undoc-members:
-
-eyed3.mp3.headers
-=================
-
-.. automodule:: eyed3.mp3.headers
-    :members:
-    :undoc-members:

File docs/api/plugins.rst

-=============
-eyed3.plugins
-=============
-
-.. automodule:: eyed3.plugins
-    :members:
-    :undoc-members:

File docs/api/utils.rst

-
-===========
-eyed3.utils
-===========
-
-.. automodule:: eyed3.utils
-    :members:
-    :undoc-members:
-
-eyed3.utils.log
-===============
-
-.. automodule:: eyed3.utils.log
-    :members:
-    :undoc-members:
-
-
-eyed3.utils.cli
-===============
-
-.. automodule:: eyed3.utils.cli
-    :members:
-    :undoc-members:
-
-eyed3.utils.binfuncs
-====================
-
-.. automodule:: eyed3.utils.binfuncs
-    :members:
-    :undoc-members:

File docs/index.rst

     :maxdepth: 2
 
     cli
-    api
+    api/modules
 
 .. toctree::
     :hidden:
 
     changelog
 
-.. _api-index:
-
 
 ChangeLog
 =========

File src/eyed3/plugins/__init__.py

 
     def handleFile(self, f, *args, **kwargs):
         '''Loads ``f`` and sets ``self.audio_file`` to an instance of
-        :class:`eyed3.core.AudioFile` or ``None`` if an error occurred.
+        :class:`eyed3.core.AudioFile` or ``None`` if an error occurred or the
+        file is not a recognized type.
 
         The ``*args`` and ``**kwargs`` are passed to :func:`eyed3.core.load`.
         '''