From c002c6780711c90dc5e9a4082e8d5e5a792f2717 Mon Sep 17 00:00:00 2001 From: dpedu Date: Fri, 19 Jun 2015 20:23:36 -0700 Subject: [PATCH] Update docs --- docs/api/irccore.rst | 10 ++ docs/api/modules/attributestorage.rst | 3 + docs/api/modules/attributestoragelite.rst | 12 +++ docs/api/modules/bitcoinprice.rst | 15 +++ docs/api/modules/calc.rst | 18 ++++ docs/api/modules/cryptowallet.rst | 3 + docs/api/modules/cryptowalletrpc.rst | 3 + docs/api/modules/dogedice.rst | 3 + docs/api/modules/dogerpc.rst | 3 + docs/api/modules/dogescramble.rst | 3 + docs/api/modules/dogewallet.rst | 3 + docs/api/modules/duckhunt.rst | 3 + docs/api/modules/error.rst | 3 +- docs/api/modules/gamebase.rst | 3 + docs/api/modules/inventory.rst | 16 +++ docs/api/modules/linktitler.rst | 10 ++ docs/api/modules/mysql.rst | 3 + docs/api/modules/nfllive.rst | 10 ++ docs/api/modules/nickuser.rst | 3 + docs/api/modules/pingresponder.rst | 6 +- docs/api/modules/randquote.rst | 15 +++ docs/api/modules/remind.rst | 18 ++++ docs/api/modules/scramble.rst | 3 +- docs/api/modules/seen.rst | 8 +- docs/api/modules/services.rst | 113 +++++++++++++++++++++- docs/api/modules/sqlite.rst | 12 +++ docs/api/modules/tell.rst | 16 +++ docs/api/modules/urban.rst | 15 +++ docs/api/modules/weather.rst | 21 ++++ docs/api/modules/youtube.rst | 16 +++ docs/api/pyircbot.rst | 2 +- docs/builder/Dockerfile | 4 +- docs/modules/_modules.rst | 2 +- docs/setup/dependancies.rst | 7 +- docs/setup/initial_config.rst | 89 +++++++---------- docs/setup/running.rst | 17 ++-- pyircbot/modules/PingResponder.py | 1 + pyircbot/modules/Services.py | 5 + 38 files changed, 425 insertions(+), 72 deletions(-) create mode 100644 docs/api/irccore.rst create mode 100644 docs/api/modules/attributestoragelite.rst create mode 100644 docs/api/modules/bitcoinprice.rst create mode 100644 docs/api/modules/calc.rst create mode 100644 docs/api/modules/inventory.rst create mode 100644 docs/api/modules/linktitler.rst create mode 100644 docs/api/modules/nfllive.rst create mode 100644 docs/api/modules/randquote.rst create mode 100644 docs/api/modules/remind.rst create mode 100644 docs/api/modules/sqlite.rst create mode 100644 docs/api/modules/tell.rst create mode 100644 docs/api/modules/urban.rst create mode 100644 docs/api/modules/weather.rst create mode 100644 docs/api/modules/youtube.rst diff --git a/docs/api/irccore.rst b/docs/api/irccore.rst new file mode 100644 index 0000000..1eed1d7 --- /dev/null +++ b/docs/api/irccore.rst @@ -0,0 +1,10 @@ +:mod:`IRCCore` --- IRC protocol client +====================================== + +A simple and generic class for interacting with the IRC protocol. + +.. automodule:: pyircbot.irccore + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/api/modules/attributestorage.rst b/docs/api/modules/attributestorage.rst index d0d1ed0..9fbb8e3 100644 --- a/docs/api/modules/attributestorage.rst +++ b/docs/api/modules/attributestorage.rst @@ -15,6 +15,9 @@ Items are dicts. An item can have many keys. Each key points to one value. +--> [ key ] --> [ value ] +Class Reference +--------------- + .. automodule:: pyircbot.modules.AttributeStorage :members: :undoc-members: diff --git a/docs/api/modules/attributestoragelite.rst b/docs/api/modules/attributestoragelite.rst new file mode 100644 index 0000000..29b719e --- /dev/null +++ b/docs/api/modules/attributestoragelite.rst @@ -0,0 +1,12 @@ +:mod:`AttributeStorageLite` --- Item key/value storage +====================================================== + +With a SQLite backend. + +Class Reference +--------------- + +.. automodule:: pyircbot.modules.AttributeStorageLite + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/modules/bitcoinprice.rst b/docs/api/modules/bitcoinprice.rst new file mode 100644 index 0000000..332bef2 --- /dev/null +++ b/docs/api/modules/bitcoinprice.rst @@ -0,0 +1,15 @@ +:mod:`BitcoinPrice` --- Fetch the current Bitcoin price +======================================================= + +Commands +-------- + + - *.btc*, *.bitcoin* - fetch the bitcoin price + +Class Reference +--------------- + +.. automodule:: pyircbot.modules.BitcoinPrice + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/modules/calc.rst b/docs/api/modules/calc.rst new file mode 100644 index 0000000..6e8247f --- /dev/null +++ b/docs/api/modules/calc.rst @@ -0,0 +1,18 @@ +:mod:`Calc` --- IRC fact game +============================= + +Commands +-------- + + - *calc* - returns a random fact + - *calc something = some definition* - add a fact + - *calc something =* - delete a fact + - *match keyword* - search facts + +Class Reference +--------------- + +.. automodule:: pyircbot.modules.Calc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/modules/cryptowallet.rst b/docs/api/modules/cryptowallet.rst index 850ac61..90de775 100644 --- a/docs/api/modules/cryptowallet.rst +++ b/docs/api/modules/cryptowallet.rst @@ -3,6 +3,9 @@ Module to provide a multi-type cryptocurrency wallet +Class Reference +--------------- + .. automodule:: pyircbot.modules.CryptoWallet :members: :undoc-members: diff --git a/docs/api/modules/cryptowalletrpc.rst b/docs/api/modules/cryptowalletrpc.rst index d4009fa..502eb64 100644 --- a/docs/api/modules/cryptowalletrpc.rst +++ b/docs/api/modules/cryptowalletrpc.rst @@ -3,6 +3,9 @@ Module capable of operating Bitcoind-style RPC. Provided as a service. +Class Reference +--------------- + .. automodule:: pyircbot.modules.CryptoWalletRPC :members: :undoc-members: diff --git a/docs/api/modules/dogedice.rst b/docs/api/modules/dogedice.rst index c3f6d62..9c78c91 100644 --- a/docs/api/modules/dogedice.rst +++ b/docs/api/modules/dogedice.rst @@ -3,6 +3,9 @@ Module to provide a game for gambling Dogecoin +Class Reference +--------------- + .. automodule:: pyircbot.modules.DogeDice :members: :undoc-members: diff --git a/docs/api/modules/dogerpc.rst b/docs/api/modules/dogerpc.rst index 83876b9..3781856 100644 --- a/docs/api/modules/dogerpc.rst +++ b/docs/api/modules/dogerpc.rst @@ -3,6 +3,9 @@ This module provides a service for interacting with dogecoind. +Class Reference +--------------- + .. automodule:: pyircbot.modules.DogeRPC :members: :undoc-members: diff --git a/docs/api/modules/dogescramble.rst b/docs/api/modules/dogescramble.rst index 81c95e7..7fe0f71 100644 --- a/docs/api/modules/dogescramble.rst +++ b/docs/api/modules/dogescramble.rst @@ -4,6 +4,9 @@ This module provides a word scrambling game that rewards winners with small amounts of Dogecoin +Class Reference +--------------- + .. automodule:: pyircbot.modules.DogeScramble :members: :undoc-members: diff --git a/docs/api/modules/dogewallet.rst b/docs/api/modules/dogewallet.rst index ebb7b56..bf488e5 100644 --- a/docs/api/modules/dogewallet.rst +++ b/docs/api/modules/dogewallet.rst @@ -3,6 +3,9 @@ This module provides a dogecoin wallet hosted on the IRC bot's server +Class Reference +--------------- + .. automodule:: pyircbot.modules.DogeWallet :members: :undoc-members: diff --git a/docs/api/modules/duckhunt.rst b/docs/api/modules/duckhunt.rst index 3efe391..b8bb8c4 100644 --- a/docs/api/modules/duckhunt.rst +++ b/docs/api/modules/duckhunt.rst @@ -3,6 +3,9 @@ An animal hunting IRC game +Class Reference +--------------- + .. automodule:: pyircbot.modules.DuckHunt :members: :undoc-members: diff --git a/docs/api/modules/error.rst b/docs/api/modules/error.rst index ea40e75..8b720f4 100644 --- a/docs/api/modules/error.rst +++ b/docs/api/modules/error.rst @@ -1,7 +1,8 @@ :mod:`Error` --- A module to cause an error =========================================== -yabba blahblah blahblah +Class Reference +--------------- .. automodule:: pyircbot.modules.Error :members: diff --git a/docs/api/modules/gamebase.rst b/docs/api/modules/gamebase.rst index d375f8b..f18bfd6 100644 --- a/docs/api/modules/gamebase.rst +++ b/docs/api/modules/gamebase.rst @@ -3,6 +3,9 @@ A codebase for making IRC games +Class Reference +--------------- + .. automodule:: pyircbot.modules.GameBase :members: :undoc-members: diff --git a/docs/api/modules/inventory.rst b/docs/api/modules/inventory.rst new file mode 100644 index 0000000..c49d738 --- /dev/null +++ b/docs/api/modules/inventory.rst @@ -0,0 +1,16 @@ +:mod:`Inventory` --- Allows the bot to carry items +================================================== + +Commands +-------- + + - *botnick: inventory* - print current inventory + - *botnick: have a x* - give the bot an item + +Class Reference +--------------- + +.. automodule:: pyircbot.modules.Inventory + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/modules/linktitler.rst b/docs/api/modules/linktitler.rst new file mode 100644 index 0000000..18d0a91 --- /dev/null +++ b/docs/api/modules/linktitler.rst @@ -0,0 +1,10 @@ +:mod:`LinkTitler` --- Fetch page titles for URLs posted in chat +=============================================================== + +Class Reference +--------------- + +.. automodule:: pyircbot.modules.LinkTitler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/modules/mysql.rst b/docs/api/modules/mysql.rst index 38e0367..e2469d2 100644 --- a/docs/api/modules/mysql.rst +++ b/docs/api/modules/mysql.rst @@ -3,6 +3,9 @@ Module providing a mysql type service +Class Reference +--------------- + .. automodule:: pyircbot.modules.MySQL :members: :undoc-members: diff --git a/docs/api/modules/nfllive.rst b/docs/api/modules/nfllive.rst new file mode 100644 index 0000000..34186dc --- /dev/null +++ b/docs/api/modules/nfllive.rst @@ -0,0 +1,10 @@ +:mod:`NFLLive` --- Fetch NFL scores & game times +================================================ + +Class Reference +--------------- + +.. automodule:: pyircbot.modules.NFLLive + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/modules/nickuser.rst b/docs/api/modules/nickuser.rst index 0e1cd67..1906665 100644 --- a/docs/api/modules/nickuser.rst +++ b/docs/api/modules/nickuser.rst @@ -3,6 +3,9 @@ A module providing a simple login/logout account service +Class Reference +--------------- + .. automodule:: pyircbot.modules.NickUser :members: :undoc-members: diff --git a/docs/api/modules/pingresponder.rst b/docs/api/modules/pingresponder.rst index 788f93f..bbdfecd 100644 --- a/docs/api/modules/pingresponder.rst +++ b/docs/api/modules/pingresponder.rst @@ -1,7 +1,11 @@ :mod:`PingResponder` --- Service ping responder =============================================== -Module to repsond to irc server PING requests +Module to repsond to irc server PING requests. This module requires no +configuration + +Class Reference +--------------- .. automodule:: pyircbot.modules.PingResponder :members: diff --git a/docs/api/modules/randquote.rst b/docs/api/modules/randquote.rst new file mode 100644 index 0000000..85a44f4 --- /dev/null +++ b/docs/api/modules/randquote.rst @@ -0,0 +1,15 @@ +:mod:`RandQuote` --- Remember and retrieve quotes +================================================= + +Commands +-------- + + - *.randomquote .randquote .rq* - fetch and say a random quote + +Class Reference +--------------- + +.. automodule:: pyircbot.modules.RandQuote + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/modules/remind.rst b/docs/api/modules/remind.rst new file mode 100644 index 0000000..b936a23 --- /dev/null +++ b/docs/api/modules/remind.rst @@ -0,0 +1,18 @@ +:mod:`Remind` --- Set reminders +=============================== + +Commands +-------- + + - *.at