Fix docs. But they're out of date.
This commit is contained in:
parent
2f2b83aab0
commit
cb5f9590c9
|
@ -4,7 +4,7 @@
|
||||||
.. note:: This is a Json RPC library by Roland Koebler and the documentation is
|
.. note:: This is a Json RPC library by Roland Koebler and the documentation is
|
||||||
included here only for developer reference.
|
included here only for developer reference.
|
||||||
|
|
||||||
.. automodule:: core.jsonrpc
|
.. automodule:: pyircbot.jsonrpc
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
|
|
||||||
yabba blahblah blahblah
|
yabba blahblah blahblah
|
||||||
|
|
||||||
.. automodule:: core.modulebase
|
.. automodule:: pyircbot.modulebase
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
|
@ -15,7 +15,7 @@ Items are dicts. An item can have many keys. Each key points to one value.
|
||||||
+--> [ key ] --> [ value ]
|
+--> [ key ] --> [ value ]
|
||||||
|
|
||||||
|
|
||||||
.. automodule:: modules.AttributeStorage
|
.. automodule:: pyircbot.modules.AttributeStorage
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
|
|
||||||
Module to provide a multi-type cryptocurrency wallet
|
Module to provide a multi-type cryptocurrency wallet
|
||||||
|
|
||||||
.. automodule:: modules.CryptoWallet
|
.. automodule:: pyircbot.modules.CryptoWallet
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
|
|
||||||
Module capable of operating Bitcoind-style RPC. Provided as a service.
|
Module capable of operating Bitcoind-style RPC. Provided as a service.
|
||||||
|
|
||||||
.. automodule:: modules.CryptoWalletRPC
|
.. automodule:: pyircbot.modules.CryptoWalletRPC
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
|
|
||||||
Module to provide a game for gambling Dogecoin
|
Module to provide a game for gambling Dogecoin
|
||||||
|
|
||||||
.. automodule:: modules.DogeDice
|
.. automodule:: pyircbot.modules.DogeDice
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
|
|
||||||
This module provides a service for interacting with dogecoind.
|
This module provides a service for interacting with dogecoind.
|
||||||
|
|
||||||
.. automodule:: modules.DogeRPC
|
.. automodule:: pyircbot.modules.DogeRPC
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
|
@ -4,7 +4,7 @@
|
||||||
This module provides a word scrambling game that rewards winners with small
|
This module provides a word scrambling game that rewards winners with small
|
||||||
amounts of Dogecoin
|
amounts of Dogecoin
|
||||||
|
|
||||||
.. automodule:: modules.DogeScramble
|
.. automodule:: pyircbot.modules.DogeScramble
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
|
|
||||||
This module provides a dogecoin wallet hosted on the IRC bot's server
|
This module provides a dogecoin wallet hosted on the IRC bot's server
|
||||||
|
|
||||||
.. automodule:: modules.DogeWallet
|
.. automodule:: pyircbot.modules.DogeWallet
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
|
|
||||||
An animal hunting IRC game
|
An animal hunting IRC game
|
||||||
|
|
||||||
.. automodule:: modules.DuckHunt
|
.. automodule:: pyircbot.modules.DuckHunt
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
|
|
||||||
yabba blahblah blahblah
|
yabba blahblah blahblah
|
||||||
|
|
||||||
.. automodule:: modules.Error
|
.. automodule:: pyircbot.modules.Error
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
|
|
||||||
A codebase for making IRC games
|
A codebase for making IRC games
|
||||||
|
|
||||||
.. automodule:: modules.GameBase
|
.. automodule:: pyircbot.modules.GameBase
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
|
|
||||||
Module providing a mysql type service
|
Module providing a mysql type service
|
||||||
|
|
||||||
.. automodule:: modules.MySQL
|
.. automodule:: pyircbot.modules.MySQL
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
|
|
||||||
A module providing a simple login/logout account service
|
A module providing a simple login/logout account service
|
||||||
|
|
||||||
.. automodule:: modules.NickUser
|
.. automodule:: pyircbot.modules.NickUser
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
|
|
||||||
Module to repsond to irc server PING requests
|
Module to repsond to irc server PING requests
|
||||||
|
|
||||||
.. automodule:: modules.PingResponder
|
.. automodule:: pyircbot.modules.PingResponder
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
|
|
||||||
yabba blahblah blahblah
|
yabba blahblah blahblah
|
||||||
|
|
||||||
.. automodule:: modules.Scramble
|
.. automodule:: pyircbot.modules.Scramble
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
|
|
||||||
Provides !seen <username>
|
Provides !seen <username>
|
||||||
|
|
||||||
.. automodule:: modules.Seen
|
.. automodule:: pyircbot.modules.Seen
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
|
|
||||||
yabba blahblah blahblah
|
yabba blahblah blahblah
|
||||||
|
|
||||||
.. automodule:: modules.Services
|
.. automodule:: pyircbot.modules.Services
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
|
|
||||||
yabba blahblah blahblah
|
yabba blahblah blahblah
|
||||||
|
|
||||||
.. automodule:: core.pyircbot
|
.. automodule:: pyircbot.pyircbot
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
|
@ -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
|
- **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.
|
- **Loaded** - Module's code exists in memory and has been instantiated. "Running" modules are of this state.
|
||||||
|
|
||||||
.. automodule:: core.rpc
|
.. automodule:: pyircbot.rpc
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
11
docs/conf.py
11
docs/conf.py
|
@ -19,11 +19,12 @@ import os
|
||||||
# If extensions (or modules to document with autodoc) are in another directory,
|
# 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
|
# 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.
|
# 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('.'))
|
||||||
sys.path.insert(0, os.path.abspath('../pyircbot/'))
|
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/'))
|
||||||
sys.path.append(os.path.abspath('../pyircbot/modules/'))
|
#sys.path.append(os.path.abspath('../pyircbot/modules/'))
|
||||||
|
|
||||||
# -- General configuration ------------------------------------------------
|
# -- General configuration ------------------------------------------------
|
||||||
|
|
||||||
|
@ -64,7 +65,7 @@ copyright = '2014, dpedu'
|
||||||
version = '3.4'
|
version = '3.4'
|
||||||
# The full version, including alpha/beta/rc tags.
|
# The full version, including alpha/beta/rc tags.
|
||||||
import pyircbot
|
import pyircbot
|
||||||
release = pyircbot.PyIRCBot.version
|
release = "4.0.0-r02"#pyircbot.PyIRCBot.version
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
# for a list of supported languages.
|
# for a list of supported languages.
|
||||||
|
|
Loading…
Reference in New Issue