Browse Source

Update API docs with config package and lazy module.

tags/v0.1^2
Ben Kurtovic 12 years ago
parent
commit
a8f2fa72f9
3 changed files with 56 additions and 6 deletions
  1. +46
    -0
      docs/api/earwigbot.config.rst
  2. +8
    -6
      docs/api/earwigbot.rst
  3. +2
    -0
      earwigbot/config/ordered_yaml.py

+ 46
- 0
docs/api/earwigbot.config.rst View File

@@ -0,0 +1,46 @@
config Package
==============

:mod:`config` Package
---------------------

.. automodule:: earwigbot.config
:members:
:undoc-members:

:mod:`formatter` Module
-----------------------

.. automodule:: earwigbot.config.formatter
:members:
:undoc-members:
:show-inheritance:

:mod:`node` Module
------------------

.. automodule:: earwigbot.config.node
:members:
:undoc-members:

:mod:`ordered_yaml` Module
--------------------------

.. automodule:: earwigbot.config.ordered_yaml
:members:
:undoc-members:
:show-inheritance:

:mod:`permissions` Module
-------------------------

.. automodule:: earwigbot.config.permissions
:members:
:undoc-members:

:mod:`script` Module
--------------------

.. automodule:: earwigbot.config.script
:members:
:undoc-members:

+ 8
- 6
docs/api/earwigbot.rst View File

@@ -15,13 +15,6 @@ earwigbot Package
:members: :members:
:undoc-members: :undoc-members:


:mod:`config` Module

.. automodule:: earwigbot.config
:members:
:undoc-members:

:mod:`exceptions` Module :mod:`exceptions` Module
------------------------ ------------------------


@@ -30,6 +23,13 @@ earwigbot Package
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:


:mod:`lazy` Module
------------------

.. automodule:: earwigbot.lazy
:members:
:undoc-members:

:mod:`managers` Module :mod:`managers` Module
---------------------- ----------------------


@@ -51,6 +51,7 @@ Subpackages
.. toctree:: .. toctree::


earwigbot.commands earwigbot.commands
earwigbot.config
earwigbot.irc earwigbot.irc
earwigbot.tasks earwigbot.tasks
earwigbot.wiki earwigbot.wiki

+ 2
- 0
earwigbot/config/ordered_yaml.py View File

@@ -22,8 +22,10 @@


""" """
Based on: Based on:

* https://gist.github.com/844388 * https://gist.github.com/844388
* http://pyyaml.org/attachment/ticket/161/use_ordered_dict.py * http://pyyaml.org/attachment/ticket/161/use_ordered_dict.py

with modifications. with modifications.
""" """




Loading…
Cancel
Save