dave/pyircbot
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix docs. But they're out of date.

Browse Source
This commit is contained in:
dpedu 2015-06-18 22:58:11 -07:00
parent 2f2b83aab0
commit cb5f9590c9
21 changed files with 26 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/jsonrpc.rst
View File

@ -4,7 +4,7 @@
.. note:: This is a Json RPC library by Roland Koebler and the documentation is
included here only for developer reference.
.. automodule:: core.jsonrpc
.. automodule:: pyircbot.jsonrpc
:members:
:undoc-members:
:show-inheritance:

2
docs/api/modulebase.rst
View File

@ -3,7 +3,7 @@
yabba blahblah blahblah
.. automodule:: core.modulebase
.. automodule:: pyircbot.modulebase
:members:
:undoc-members:
:show-inheritance:

2
docs/api/modules/attributestorage.rst
View File

@ -15,7 +15,7 @@ Items are dicts. An item can have many keys. Each key points to one value.
+--> [ key ] --> [ value ]
.. automodule:: modules.AttributeStorage
.. automodule:: pyircbot.modules.AttributeStorage
:members:
:undoc-members:
:show-inheritance:

2
docs/api/modules/cryptowallet.rst
View File

@ -3,7 +3,7 @@
Module to provide a multi-type cryptocurrency wallet
.. automodule:: modules.CryptoWallet
.. automodule:: pyircbot.modules.CryptoWallet
:members:
:undoc-members:
:show-inheritance:

2
docs/api/modules/cryptowalletrpc.rst
View File

@ -3,7 +3,7 @@
Module capable of operating Bitcoind-style RPC. Provided as a service.
.. automodule:: modules.CryptoWalletRPC
.. automodule:: pyircbot.modules.CryptoWalletRPC
:members:
:undoc-members:
:show-inheritance:

2
docs/api/modules/dogedice.rst
View File

@ -3,7 +3,7 @@
Module to provide a game for gambling Dogecoin
.. automodule:: modules.DogeDice
.. automodule:: pyircbot.modules.DogeDice
:members:
:undoc-members:
:show-inheritance:

2
docs/api/modules/dogerpc.rst
View File

@ -3,7 +3,7 @@
This module provides a service for interacting with dogecoind.
.. automodule:: modules.DogeRPC
.. automodule:: pyircbot.modules.DogeRPC
:members:
:undoc-members:
:show-inheritance:

2
docs/api/modules/dogescramble.rst
View File

@ -4,7 +4,7 @@
This module provides a word scrambling game that rewards winners with small
amounts of Dogecoin
.. automodule:: modules.DogeScramble
.. automodule:: pyircbot.modules.DogeScramble
:members:
:undoc-members:
:show-inheritance:

2
docs/api/modules/dogewallet.rst
View File

@ -3,7 +3,7 @@
This module provides a dogecoin wallet hosted on the IRC bot's server
.. automodule:: modules.DogeWallet
.. automodule:: pyircbot.modules.DogeWallet
:members:
:undoc-members:
:show-inheritance:

2
docs/api/modules/duckhunt.rst
View File

@ -3,7 +3,7 @@
An animal hunting IRC game
.. automodule:: modules.DuckHunt
.. automodule:: pyircbot.modules.DuckHunt
:members:
:undoc-members:
:show-inheritance:

2
docs/api/modules/error.rst
View File

@ -3,7 +3,7 @@
yabba blahblah blahblah
.. automodule:: modules.Error
.. automodule:: pyircbot.modules.Error
:members:
:undoc-members:
:show-inheritance:

2
docs/api/modules/gamebase.rst
View File

@ -3,7 +3,7 @@
A codebase for making IRC games
.. automodule:: modules.GameBase
.. automodule:: pyircbot.modules.GameBase
:members:
:undoc-members:
:show-inheritance:

2
docs/api/modules/mysql.rst
View File

@ -3,7 +3,7 @@
Module providing a mysql type service
.. automodule:: modules.MySQL
.. automodule:: pyircbot.modules.MySQL
:members:
:undoc-members:
:show-inheritance:

2
docs/api/modules/nickuser.rst
View File

@ -3,7 +3,7 @@
A module providing a simple login/logout account service
.. automodule:: modules.NickUser
.. automodule:: pyircbot.modules.NickUser
:members:
:undoc-members:
:show-inheritance:

2
docs/api/modules/pingresponder.rst
View File

@ -3,7 +3,7 @@
Module to repsond to irc server PING requests
.. automodule:: modules.PingResponder
.. automodule:: pyircbot.modules.PingResponder
:members:
:undoc-members:
:show-inheritance:

2
docs/api/modules/scramble.rst
View File

@ -3,7 +3,7 @@
yabba blahblah blahblah
.. automodule:: modules.Scramble
.. automodule:: pyircbot.modules.Scramble
:members:
:undoc-members:
:show-inheritance:

2
docs/api/modules/seen.rst
View File

@ -3,7 +3,7 @@
Provides !seen <username>
.. automodule:: modules.Seen
.. automodule:: pyircbot.modules.Seen
:members:
:undoc-members:
:show-inheritance:

2
docs/api/modules/services.rst
View File

@ -3,7 +3,7 @@
yabba blahblah blahblah
.. automodule:: modules.Services
.. automodule:: pyircbot.modules.Services
:members:
:undoc-members:
:show-inheritance:

2
docs/api/pyircbot.rst
View File

@ -3,7 +3,7 @@
yabba blahblah blahblah
.. automodule:: core.pyircbot
.. automodule:: pyircbot.pyircbot
:members:
:undoc-members:
:show-inheritance:

2
docs/api/rpc.rst
View File

@ -10,7 +10,7 @@ It's important to know the different states a module can be in.
- **Imported** - Module's code exists in memory but has not been instantiated
- **Loaded** - Module's code exists in memory and has been instantiated. "Running" modules are of this state.
.. automodule:: core.rpc
.. automodule:: pyircbot.rpc
:members:
:undoc-members:
:show-inheritance:

11
docs/conf.py
View File

@ -19,11 +19,12 @@ import os
# If extensions (or modules to document with autodoc) are in another directory,
# 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.
#sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('../pyircbot/'))
sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('../'))
#sys.path.insert(0, os.path.abspath('../pyircbot/'))
sys.path.append(os.path.abspath('../pyircbot/core/'))
sys.path.append(os.path.abspath('../pyircbot/modules/'))
#sys.path.append(os.path.abspath('../pyircbot/'))
#sys.path.append(os.path.abspath('../pyircbot/modules/'))
# -- General configuration ------------------------------------------------
@ -64,7 +65,7 @@ copyright = '2014, dpedu'
version = '3.4'
# The full version, including alpha/beta/rc tags.
import pyircbot
release = pyircbot.PyIRCBot.version
release = "4.0.0-r02"#pyircbot.PyIRCBot.version
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.