Update docs & docbuilder
This commit is contained in:
parent
f4fda5f60d
commit
ab8c3978fb
|
@ -1,21 +1,25 @@
|
|||
FROM ubuntu:trusty
|
||||
|
||||
COPY start /start
|
||||
FROM ubuntu:xenial
|
||||
|
||||
RUN apt-get update ; \
|
||||
apt-get install -y python3 python3-sphinx python3-setuptools python3-dev python3-requests python3-pip python3-lxml make wget unzip libmysqlclient-dev ; \
|
||||
pip3 install pytz praw ; \
|
||||
cd /tmp ; \
|
||||
apt-get install -y python3 python3-sphinx python3-setuptools python3-dev python3-requests python3-pip python3-lxml make wget unzip libmysqlclient-dev
|
||||
|
||||
RUN pip3 install pytz praw
|
||||
|
||||
RUN cd /tmp ; \
|
||||
wget https://github.com/jgarzik/python-bitcoinrpc/archive/master.zip ; \
|
||||
unzip master.zip ; \
|
||||
cd python-bitcoinrpc-master/ ; \
|
||||
python3 setup.py install ; \
|
||||
cd /tmp ; \
|
||||
python3 setup.py install
|
||||
|
||||
RUN cd /tmp ; \
|
||||
wget https://github.com/dpedu/MySQL-for-Python-3/archive/master.zip -O mysqldb.zip ; \
|
||||
unzip mysqldb.zip ; \
|
||||
cd MySQL-for-Python-3-master/ ; \
|
||||
python3 setup.py install ; \
|
||||
chmod +x /start ; \
|
||||
python3 setup.py install
|
||||
|
||||
COPY start /start
|
||||
|
||||
RUN chmod +x /start ; \
|
||||
mkdir /tmp/docs
|
||||
|
||||
CMD /start
|
||||
ENTRYPOINT ["/start"]
|
||||
|
|
|
@ -10,4 +10,5 @@ A docker image for building pyircbot's docs.
|
|||
|
||||
Or, use a local directory instead of git master and build docs into `docs/_build/html`:
|
||||
|
||||
* `docker run -it --rm -v /localpath/to/pyircbot/repo/:/tmp/pyircbot pyircbotdocbuilder /start`
|
||||
* `mkdir docs/_build`
|
||||
* `docker run -it --rm -v /localpath/to/pyircbot/repo/:/tmp/pyircbot/ pybdocbuilder`
|
||||
|
|
|
@ -2,10 +2,11 @@
|
|||
cd /tmp
|
||||
if [ ! -d "pyircbot" ] ; then
|
||||
mkdir pyircbot
|
||||
wget http://gitlab.xmopx.net/dave/pyircbot3/repository/archive.tar.gz?ref=master -O pyircbot.tgz
|
||||
wget http://gitlab.davepedu.com/dave/pyircbot3/repository/archive.tar.gz?ref=master -O pyircbot.tgz
|
||||
tar zxvf pyircbot.tgz -C pyircbot/ --strip-components=1
|
||||
fi
|
||||
cd pyircbot/docs/
|
||||
make html
|
||||
rm -rf /tmp/docs/*
|
||||
cp -r _build/html/* /tmp/docs/
|
||||
chown -R 1000:1000 /tmp/docs/*
|
||||
|
|
|
@ -26,7 +26,8 @@ modules one after the other so a long delay slows bot startup.
|
|||
def __init__(self, bot, moduleName):
|
||||
ModuleBase.__init__(self, bot, moduleName)
|
||||
|
||||
If your module has a config file - EchoExample.json - it can be loaded by
|
||||
If your module has a config file - EchoExample.json - it will be automatically
|
||||
loaded on module startup. It can be manually reloaded by
|
||||
calling :py:meth:`pyircbot.modulebase.ModuleBase.loadConfig`:
|
||||
|
||||
.. code-block:: python
|
||||
|
|
|
@ -2,8 +2,8 @@
|
|||
Dependencies
|
||||
************
|
||||
|
||||
PyIRCBot is designed to run on Python 3, and is usually tested with 3.4. Python
|
||||
2.x is not supported.
|
||||
PyIRCBot is designed to run on Python 3.5+, and is usually tested with 3.5.
|
||||
Python 2.x and older versions of 3.x are not supported.
|
||||
|
||||
Although **no** non-core modules are needed to run PyIRCBot in it's most basic
|
||||
form, not all features and modules will be available.
|
||||
|
|
Loading…
Reference in New Issue