diff --git a/docs/api/jsonrpc.rst b/docs/api/jsonrpc.rst index 9f905e0..e82b4a6 100644 --- a/docs/api/jsonrpc.rst +++ b/docs/api/jsonrpc.rst @@ -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: diff --git a/docs/api/modulebase.rst b/docs/api/modulebase.rst index af3dd81..3cf64b3 100644 --- a/docs/api/modulebase.rst +++ b/docs/api/modulebase.rst @@ -3,7 +3,7 @@ yabba blahblah blahblah -.. automodule:: core.modulebase +.. automodule:: pyircbot.modulebase :members: :undoc-members: :show-inheritance: diff --git a/docs/api/modules/attributestorage.rst b/docs/api/modules/attributestorage.rst index 906ded8..d0d1ed0 100644 --- a/docs/api/modules/attributestorage.rst +++ b/docs/api/modules/attributestorage.rst @@ -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: diff --git a/docs/api/modules/cryptowallet.rst b/docs/api/modules/cryptowallet.rst index 504e2eb..850ac61 100644 --- a/docs/api/modules/cryptowallet.rst +++ b/docs/api/modules/cryptowallet.rst @@ -3,7 +3,7 @@ Module to provide a multi-type cryptocurrency wallet -.. automodule:: modules.CryptoWallet +.. automodule:: pyircbot.modules.CryptoWallet :members: :undoc-members: :show-inheritance: diff --git a/docs/api/modules/cryptowalletrpc.rst b/docs/api/modules/cryptowalletrpc.rst index bedad0a..d4009fa 100644 --- a/docs/api/modules/cryptowalletrpc.rst +++ b/docs/api/modules/cryptowalletrpc.rst @@ -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: diff --git a/docs/api/modules/dogedice.rst b/docs/api/modules/dogedice.rst index 6dfeb01..c3f6d62 100644 --- a/docs/api/modules/dogedice.rst +++ b/docs/api/modules/dogedice.rst @@ -3,7 +3,7 @@ Module to provide a game for gambling Dogecoin -.. automodule:: modules.DogeDice +.. automodule:: pyircbot.modules.DogeDice :members: :undoc-members: :show-inheritance: diff --git a/docs/api/modules/dogerpc.rst b/docs/api/modules/dogerpc.rst index 17555b8..83876b9 100644 --- a/docs/api/modules/dogerpc.rst +++ b/docs/api/modules/dogerpc.rst @@ -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: diff --git a/docs/api/modules/dogescramble.rst b/docs/api/modules/dogescramble.rst index 3ceccbf..81c95e7 100644 --- a/docs/api/modules/dogescramble.rst +++ b/docs/api/modules/dogescramble.rst @@ -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: diff --git a/docs/api/modules/dogewallet.rst b/docs/api/modules/dogewallet.rst index a04e147..ebb7b56 100644 --- a/docs/api/modules/dogewallet.rst +++ b/docs/api/modules/dogewallet.rst @@ -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: diff --git a/docs/api/modules/duckhunt.rst b/docs/api/modules/duckhunt.rst index e559c07..3efe391 100644 --- a/docs/api/modules/duckhunt.rst +++ b/docs/api/modules/duckhunt.rst @@ -3,7 +3,7 @@ An animal hunting IRC game -.. automodule:: modules.DuckHunt +.. automodule:: pyircbot.modules.DuckHunt :members: :undoc-members: :show-inheritance: diff --git a/docs/api/modules/error.rst b/docs/api/modules/error.rst index 4b3e3b2..ea40e75 100644 --- a/docs/api/modules/error.rst +++ b/docs/api/modules/error.rst @@ -3,7 +3,7 @@ yabba blahblah blahblah -.. automodule:: modules.Error +.. automodule:: pyircbot.modules.Error :members: :undoc-members: :show-inheritance: diff --git a/docs/api/modules/gamebase.rst b/docs/api/modules/gamebase.rst index 89b6d40..d375f8b 100644 --- a/docs/api/modules/gamebase.rst +++ b/docs/api/modules/gamebase.rst @@ -3,7 +3,7 @@ A codebase for making IRC games -.. automodule:: modules.GameBase +.. automodule:: pyircbot.modules.GameBase :members: :undoc-members: :show-inheritance: diff --git a/docs/api/modules/mysql.rst b/docs/api/modules/mysql.rst index 638924f..38e0367 100644 --- a/docs/api/modules/mysql.rst +++ b/docs/api/modules/mysql.rst @@ -3,7 +3,7 @@ Module providing a mysql type service -.. automodule:: modules.MySQL +.. automodule:: pyircbot.modules.MySQL :members: :undoc-members: :show-inheritance: diff --git a/docs/api/modules/nickuser.rst b/docs/api/modules/nickuser.rst index 1c01c6e..9e6c7f6 100644 --- a/docs/api/modules/nickuser.rst +++ b/docs/api/modules/nickuser.rst @@ -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: diff --git a/docs/api/modules/pingresponder.rst b/docs/api/modules/pingresponder.rst index 8085567..788f93f 100644 --- a/docs/api/modules/pingresponder.rst +++ b/docs/api/modules/pingresponder.rst @@ -3,7 +3,7 @@ Module to repsond to irc server PING requests -.. automodule:: modules.PingResponder +.. automodule:: pyircbot.modules.PingResponder :members: :undoc-members: :show-inheritance: diff --git a/docs/api/modules/scramble.rst b/docs/api/modules/scramble.rst index 37941cd..5805beb 100644 --- a/docs/api/modules/scramble.rst +++ b/docs/api/modules/scramble.rst @@ -3,7 +3,7 @@ yabba blahblah blahblah -.. automodule:: modules.Scramble +.. automodule:: pyircbot.modules.Scramble :members: :undoc-members: :show-inheritance: diff --git a/docs/api/modules/seen.rst b/docs/api/modules/seen.rst index 5e95362..16d5e24 100644 --- a/docs/api/modules/seen.rst +++ b/docs/api/modules/seen.rst @@ -3,7 +3,7 @@ Provides !seen -.. automodule:: modules.Seen +.. automodule:: pyircbot.modules.Seen :members: :undoc-members: :show-inheritance: diff --git a/docs/api/modules/services.rst b/docs/api/modules/services.rst index ac2d3e1..a0b8f38 100644 --- a/docs/api/modules/services.rst +++ b/docs/api/modules/services.rst @@ -3,7 +3,7 @@ yabba blahblah blahblah -.. automodule:: modules.Services +.. automodule:: pyircbot.modules.Services :members: :undoc-members: :show-inheritance: diff --git a/docs/api/pyircbot.rst b/docs/api/pyircbot.rst index e6196a4..1868d4a 100644 --- a/docs/api/pyircbot.rst +++ b/docs/api/pyircbot.rst @@ -3,7 +3,7 @@ yabba blahblah blahblah -.. automodule:: core.pyircbot +.. automodule:: pyircbot.pyircbot :members: :undoc-members: :show-inheritance: diff --git a/docs/api/rpc.rst b/docs/api/rpc.rst index fb3a1e1..d1d0988 100644 --- a/docs/api/rpc.rst +++ b/docs/api/rpc.rst @@ -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: diff --git a/docs/conf.py b/docs/conf.py index cbfa3df..fc1bab2 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -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.