Merge pull request #52 from avocado-framework/auto-generate-api-docs

Auto generate api docs

docs/source/api/.gitignore

+*.rst

docs/source/api/avocado.cli.rst

-cli Package
-===========
-
-:mod:`cli` Package
-------------------
-
-.. automodule:: avocado.cli
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`app` Module
------------------
-
-.. automodule:: avocado.cli.app
-    :members:
-    :undoc-members:
-    :show-inheritance:
-

docs/source/api/avocado.core.rst

-core Package
-============
-
-:mod:`core` Package
--------------------
-
-.. automodule:: avocado.core
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`data_dir` Module
-----------------------
-
-.. automodule:: avocado.core.data_dir
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`error_codes` Module
--------------------------
-
-.. automodule:: avocado.core.error_codes
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`exceptions` Module
-------------------------
-
-.. automodule:: avocado.core.exceptions
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`output` Module
---------------------
-
-.. automodule:: avocado.core.output
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`status` Module
---------------------
-
-.. automodule:: avocado.core.status
-    :members:
-    :undoc-members:
-    :show-inheritance:
-

docs/source/api/avocado.linux.rst

-linux Package
-=============
-
-:mod:`linux` Package
---------------------
-
-.. automodule:: avocado.linux
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`distro` Module
---------------------
-
-.. automodule:: avocado.linux.distro
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`software_manager` Module
-------------------------------
-
-.. automodule:: avocado.linux.software_manager
-    :members:
-    :undoc-members:
-    :show-inheritance:
-

docs/source/api/avocado.plugins.rst

-plugins Package
-===============
-
-:mod:`plugins` Package
-----------------------
-
-.. automodule:: avocado.plugins
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`builtin` Module
----------------------
-
-.. automodule:: avocado.plugins.builtin
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`datadir` Module
----------------------
-
-.. automodule:: avocado.plugins.datadir
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`journal` Module
----------------------
-
-.. automodule:: avocado.plugins.journal
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`lister` Module
---------------------
-
-.. automodule:: avocado.plugins.lister
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`manager` Module
----------------------
-
-.. automodule:: avocado.plugins.manager
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`plugin` Module
---------------------
-
-.. automodule:: avocado.plugins.plugin
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`runner` Module
---------------------
-
-.. automodule:: avocado.plugins.runner
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`xunit` Module
--------------------
-
-.. automodule:: avocado.plugins.xunit
-    :members:
-    :undoc-members:
-    :show-inheritance:
-

docs/source/api/avocado.rst

-avocado Package
-===============
-
-:mod:`avocado` Package
-----------------------
-
-.. automodule:: avocado.__init__
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`job` Module
------------------
-
-.. automodule:: avocado.job
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`profiler` Module
-----------------------
-
-.. automodule:: avocado.profiler
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`result` Module
---------------------
-
-.. automodule:: avocado.result
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`settings` Module
-----------------------
-
-.. automodule:: avocado.settings
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`sysinfo` Module
----------------------
-
-.. automodule:: avocado.sysinfo
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`test` Module
-------------------
-
-.. automodule:: avocado.test
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`version` Module
----------------------
-
-.. automodule:: avocado.version
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-Subpackages
------------
-
-.. toctree::
-
-    avocado.cli
-    avocado.core
-    avocado.linux
-    avocado.plugins
-    avocado.utils
-

docs/source/api/avocado.utils.rst

-utils Package
-=============
-
-:mod:`utils` Package
---------------------
-
-.. automodule:: avocado.utils
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`archive` Module
----------------------
-
-.. automodule:: avocado.utils.archive
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`build` Module
--------------------
-
-.. automodule:: avocado.utils.build
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`crypto` Module
---------------------
-
-.. automodule:: avocado.utils.crypto
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`download` Module
-----------------------
-
-.. automodule:: avocado.utils.download
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`memory` Module
---------------------
-
-.. automodule:: avocado.utils.memory
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`misc` Module
-------------------
-
-.. automodule:: avocado.utils.misc
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`network` Module
----------------------
-
-.. automodule:: avocado.utils.network
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`process` Module
----------------------
-
-.. automodule:: avocado.utils.process
-    :members:
-    :undoc-members:
-    :show-inheritance:
-

docs/source/api/modules.rst

-avocado
-=======
-
-.. toctree::
-   :maxdepth: 4
-
-   avocado

docs/source/conf.py

@@ -33,6 +33,13 @@ import os
 root_path = os.path.abspath(os.path.join("..", ".."))
 sys.path.insert(0, root_path)
 
+# Auto generate API documentation
+from avocado.utils import process
+_sphinx_apidoc = process.find_command('sphinx-apidoc')
+_output_dir = os.path.join(root_path, 'docs', 'source', 'api')
+_api_dir = os.path.join(root_path, 'avocado')
+process.run("%s -o %s %s" % (_sphinx_apidoc, _output_dir, _api_dir))
+
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.