Build the reference documentation

docs/conf.py

@@ -10,9 +10,9 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
 
 
 # -- Project information -----------------------------------------------------

docs/index.rst

@@ -10,6 +10,7 @@ Welcome to fuss-manager's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   reference
 
 
 Indices and tables

docs/manager/manager.compat.rst

+manager.compat module
+=====================
+
+.. automodule:: manager.compat
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.config.rst

+manager.config module
+=====================
+
+.. automodule:: manager.config
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.events.rst

+manager.events module
+=====================
+
+.. automodule:: manager.events
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.manager.rst

+manager.manager module
+======================
+
+.. automodule:: manager.manager
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.ops.rst

+manager.ops module
+==================
+
+.. automodule:: manager.ops
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.perms.rst

+manager.perms module
+====================
+
+.. automodule:: manager.perms
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.playbook.rst

+manager.playbook module
+=======================
+
+.. automodule:: manager.playbook
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.rst

+manager package
+===============
+
+.. automodule:: manager
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+   manager.sources
+   manager.users
+   manager.web
+
+Submodules
+----------
+
+.. toctree::
+
+   manager.compat
+   manager.config
+   manager.events
+   manager.manager
+   manager.ops
+   manager.perms
+   manager.playbook
+   manager.signing
+   manager.stores

docs/manager/manager.signing.rst

+manager.signing module
+======================
+
+.. automodule:: manager.signing
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.sources.arpwatch.rst

+manager.sources.arpwatch module
+===============================
+
+.. automodule:: manager.sources.arpwatch
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.sources.base.rst

+manager.sources.base module
+===========================
+
+.. automodule:: manager.sources.base
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.sources.chaos.rst

+manager.sources.chaos module
+============================
+
+.. automodule:: manager.sources.chaos
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.sources.command.rst

+manager.sources.command module
+==============================
+
+.. automodule:: manager.sources.command
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.sources.dhcp.rst

+manager.sources.dhcp module
+===========================
+
+.. automodule:: manager.sources.dhcp
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.sources.inotifywait.rst

+manager.sources.inotifywait module
+==================================
+
+.. automodule:: manager.sources.inotifywait
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.sources.rst

+manager.sources package
+=======================
+
+.. automodule:: manager.sources
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   manager.sources.arpwatch
+   manager.sources.base
+   manager.sources.chaos
+   manager.sources.command
+   manager.sources.dhcp
+   manager.sources.inotifywait

docs/manager/manager.stores.rst

+manager.stores module
+=====================
+
+.. automodule:: manager.stores
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.users.db.rst

+manager.users.db module
+=======================
+
+.. automodule:: manager.users.db
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.users.ldap.rst

+manager.users.ldap module
+=========================
+
+.. automodule:: manager.users.ldap
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.users.local.rst

+manager.users.local module
+==========================
+
+.. automodule:: manager.users.local
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.users.master.rst

+manager.users.master module
+===========================
+
+.. automodule:: manager.users.master
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.users.mock.rst

+manager.users.mock module
+=========================
+
+.. automodule:: manager.users.mock
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.users.rst

+manager.users package
+=====================
+
+.. automodule:: manager.users
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   manager.users.db
+   manager.users.ldap
+   manager.users.local
+   manager.users.master
+   manager.users.mock

docs/manager/manager.web.rst

+manager.web package
+===================
+
+.. automodule:: manager.web
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   manager.web.server
+   manager.web.session
+   manager.web.static
+   manager.web.views
+   manager.web.webapi

docs/manager/manager.web.server.rst

+manager.web.server module
+=========================
+
+.. automodule:: manager.web.server
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.web.session.rst

+manager.web.session module
+==========================
+
+.. automodule:: manager.web.session
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.web.static.rst

+manager.web.static module
+=========================
+
+.. automodule:: manager.web.static
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.web.views.rst

+manager.web.views module
+========================
+
+.. automodule:: manager.web.views
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/manager/manager.web.webapi.rst

+manager.web.webapi module
+=========================
+
+.. automodule:: manager.web.webapi
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/reference.rst

+*************************
+ Reference documentation
+*************************
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   manager/manager