Browse Source
* First stab at reworking docs * Take a stab at some client documentation * More DOCS stuff * more docs stuffpull/27/merge
Andrei Zbikowski
8 years ago
committed by
GitHub
GitHub
22 changed files with 237 additions and 1071 deletions
@ -0,0 +1,8 @@ |
|||
name: Disco |
|||
|
|||
rules: |
|||
disco/*.py: |
|||
parser: numpy |
|||
|
|||
outputs: |
|||
- {type: markdown, path: docs/api/, title: 'Disco Documentation'} |
|||
@ -1,7 +1,13 @@ |
|||
build/ |
|||
dist/ |
|||
disco*.egg-info/ |
|||
docs/_build |
|||
storage.db |
|||
storage.json |
|||
*.dca |
|||
.eggs/ |
|||
|
|||
# Documentation stuff |
|||
docs/api/ |
|||
docs/_build |
|||
_book/ |
|||
node_modules/ |
|||
|
|||
Binary file not shown.
@ -1,225 +0,0 @@ |
|||
# Makefile for Sphinx documentation
|
|||
#
|
|||
|
|||
# You can set these variables from the command line.
|
|||
SPHINXOPTS = |
|||
SPHINXBUILD = sphinx-build |
|||
PAPER = |
|||
BUILDDIR = _build |
|||
|
|||
# Internal variables.
|
|||
PAPEROPT_a4 = -D latex_paper_size=a4 |
|||
PAPEROPT_letter = -D latex_paper_size=letter |
|||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . |
|||
# the i18n builder cannot share the environment and doctrees with the others
|
|||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . |
|||
|
|||
.PHONY: help |
|||
help: |
|||
@echo "Please use \`make <target>' where <target> is one of" |
|||
@echo " html to make standalone HTML files" |
|||
@echo " dirhtml to make HTML files named index.html in directories" |
|||
@echo " singlehtml to make a single large HTML file" |
|||
@echo " pickle to make pickle files" |
|||
@echo " json to make JSON files" |
|||
@echo " htmlhelp to make HTML files and a HTML help project" |
|||
@echo " qthelp to make HTML files and a qthelp project" |
|||
@echo " applehelp to make an Apple Help Book" |
|||
@echo " devhelp to make HTML files and a Devhelp project" |
|||
@echo " epub to make an epub" |
|||
@echo " epub3 to make an epub3" |
|||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" |
|||
@echo " latexpdf to make LaTeX files and run them through pdflatex" |
|||
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" |
|||
@echo " text to make text files" |
|||
@echo " man to make manual pages" |
|||
@echo " texinfo to make Texinfo files" |
|||
@echo " info to make Texinfo files and run them through makeinfo" |
|||
@echo " gettext to make PO message catalogs" |
|||
@echo " changes to make an overview of all changed/added/deprecated items" |
|||
@echo " xml to make Docutils-native XML files" |
|||
@echo " pseudoxml to make pseudoxml-XML files for display purposes" |
|||
@echo " linkcheck to check all external links for integrity" |
|||
@echo " doctest to run all doctests embedded in the documentation (if enabled)" |
|||
@echo " coverage to run coverage check of the documentation (if enabled)" |
|||
@echo " dummy to check syntax errors of document sources" |
|||
|
|||
.PHONY: clean |
|||
clean: |
|||
rm -rf $(BUILDDIR)/* |
|||
|
|||
.PHONY: html |
|||
html: |
|||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html |
|||
@echo |
|||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html." |
|||
|
|||
.PHONY: dirhtml |
|||
dirhtml: |
|||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml |
|||
@echo |
|||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." |
|||
|
|||
.PHONY: singlehtml |
|||
singlehtml: |
|||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml |
|||
@echo |
|||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." |
|||
|
|||
.PHONY: pickle |
|||
pickle: |
|||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle |
|||
@echo |
|||
@echo "Build finished; now you can process the pickle files." |
|||
|
|||
.PHONY: json |
|||
json: |
|||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json |
|||
@echo |
|||
@echo "Build finished; now you can process the JSON files." |
|||
|
|||
.PHONY: htmlhelp |
|||
htmlhelp: |
|||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp |
|||
@echo |
|||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
|||
".hhp project file in $(BUILDDIR)/htmlhelp." |
|||
|
|||
.PHONY: qthelp |
|||
qthelp: |
|||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp |
|||
@echo |
|||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
|||
".qhcp project file in $(BUILDDIR)/qthelp, like this:" |
|||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/disco.qhcp" |
|||
@echo "To view the help file:" |
|||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/disco.qhc" |
|||
|
|||
.PHONY: applehelp |
|||
applehelp: |
|||
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp |
|||
@echo |
|||
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp." |
|||
@echo "N.B. You won't be able to view it unless you put it in" \
|
|||
"~/Library/Documentation/Help or install it in your application" \
|
|||
"bundle." |
|||
|
|||
.PHONY: devhelp |
|||
devhelp: |
|||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp |
|||
@echo |
|||
@echo "Build finished." |
|||
@echo "To view the help file:" |
|||
@echo "# mkdir -p $$HOME/.local/share/devhelp/disco" |
|||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/disco" |
|||
@echo "# devhelp" |
|||
|
|||
.PHONY: epub |
|||
epub: |
|||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub |
|||
@echo |
|||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub." |
|||
|
|||
.PHONY: epub3 |
|||
epub3: |
|||
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 |
|||
@echo |
|||
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." |
|||
|
|||
.PHONY: latex |
|||
latex: |
|||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
|||
@echo |
|||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." |
|||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
|||
"(use \`make latexpdf' here to do that automatically)." |
|||
|
|||
.PHONY: latexpdf |
|||
latexpdf: |
|||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
|||
@echo "Running LaTeX files through pdflatex..." |
|||
$(MAKE) -C $(BUILDDIR)/latex all-pdf |
|||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." |
|||
|
|||
.PHONY: latexpdfja |
|||
latexpdfja: |
|||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
|||
@echo "Running LaTeX files through platex and dvipdfmx..." |
|||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja |
|||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." |
|||
|
|||
.PHONY: text |
|||
text: |
|||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text |
|||
@echo |
|||
@echo "Build finished. The text files are in $(BUILDDIR)/text." |
|||
|
|||
.PHONY: man |
|||
man: |
|||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man |
|||
@echo |
|||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man." |
|||
|
|||
.PHONY: texinfo |
|||
texinfo: |
|||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo |
|||
@echo |
|||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." |
|||
@echo "Run \`make' in that directory to run these through makeinfo" \
|
|||
"(use \`make info' here to do that automatically)." |
|||
|
|||
.PHONY: info |
|||
info: |
|||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo |
|||
@echo "Running Texinfo files through makeinfo..." |
|||
make -C $(BUILDDIR)/texinfo info |
|||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." |
|||
|
|||
.PHONY: gettext |
|||
gettext: |
|||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale |
|||
@echo |
|||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." |
|||
|
|||
.PHONY: changes |
|||
changes: |
|||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes |
|||
@echo |
|||
@echo "The overview file is in $(BUILDDIR)/changes." |
|||
|
|||
.PHONY: linkcheck |
|||
linkcheck: |
|||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck |
|||
@echo |
|||
@echo "Link check complete; look for any errors in the above output " \
|
|||
"or in $(BUILDDIR)/linkcheck/output.txt." |
|||
|
|||
.PHONY: doctest |
|||
doctest: |
|||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest |
|||
@echo "Testing of doctests in the sources finished, look at the " \
|
|||
"results in $(BUILDDIR)/doctest/output.txt." |
|||
|
|||
.PHONY: coverage |
|||
coverage: |
|||
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage |
|||
@echo "Testing of coverage in the sources finished, look at the " \
|
|||
"results in $(BUILDDIR)/coverage/python.txt." |
|||
|
|||
.PHONY: xml |
|||
xml: |
|||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml |
|||
@echo |
|||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml." |
|||
|
|||
.PHONY: pseudoxml |
|||
pseudoxml: |
|||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml |
|||
@echo |
|||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." |
|||
|
|||
.PHONY: dummy |
|||
dummy: |
|||
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy |
|||
@echo |
|||
@echo "Build finished. Dummy builder generates no files." |
|||
@ -0,0 +1,14 @@ |
|||
# Disco |
|||
|
|||
Disco is a simple, clean and extendable library for the [Discord API](https://dis.gd/docs). Disco is built and aimed at developers looking to quickly start building bots that can be grown and extended to live on thousands of servers, and have immense functionality. To facilitate this, Disco provides a clean and simple interface which gets out of the way, but never sacrifices functionality. Disco is actively used by the staff at Discord to help us build and test Discord. |
|||
|
|||
## Stability |
|||
|
|||
Disco is still a relatively young library, and as such it bears the "alpha" tag. For the most part, this means that while the general API and functionality may change or vary from version to version, the core concepts and features shouldn't diverge much. A benefit of this comes in the form of bleeding edge features and support for the latest Discord version. |
|||
|
|||
## Highlights |
|||
|
|||
* Expressive, Idiomatic, and Functional - the API interface stays out of our way, while giving you the required power |
|||
* Performant and Efficient - allowing you to build bots that operate on many thousands of servers, without manual sharding |
|||
* Modular and Extendable - take only the bits you need to build what you want, while being able to add or remove functionality by installing packages |
|||
* Python 2.x/3.x Support - build integrations with the version of Python you need to |
|||
@ -0,0 +1,62 @@ |
|||
# Summary |
|||
|
|||
* [Introduction](README.md) |
|||
* [Installation and Setup](installation.md) |
|||
* [Bot Tutorial](bot_tutorial/intro.md) |
|||
* [Creating and Running a Bot](bot_tutorial/first_steps.md) |
|||
* [Plugins](bot_tutorial/building_block_plugins.md) |
|||
* [Commands](bot_tutorial/building_block_commands.md) |
|||
* [Listeners](bot_tutorial/building_block_listeners.md) |
|||
* [Message Embeds](bot_tutorial/message_embeds.md) |
|||
* [Advanced](bot_tutorial/advanced.md) |
|||
* API Docs |
|||
* [disco.client](api/disco_client.md) |
|||
* [disco.state](api/disco_state.md) |
|||
* [disco.cli](api/disco_cli.md) |
|||
* Bot |
|||
* [disco.bot.bot](api/disco_bot_bot.md) |
|||
* [disco.bot.plugin](api/disco_bot_plugin.md) |
|||
* [disco.bot.command](api/disco_bot_command.md) |
|||
* [disco.bot.storage](api/disco_bot_storage.md) |
|||
* [disco.bot.parser](api/disco_bot_parser.md) |
|||
* API |
|||
* [disco.api.client](api/disco_api_client.md) |
|||
* [disco.api.http](api/disco_api_http.md) |
|||
* [disco.api.ratelimit](api/disco_api_ratelimit.md) |
|||
* Gateway |
|||
* [disco.gateway.client](api/disco_gateway_client.md) |
|||
* [disco.gateway.events](api/disco_gateway_events.md) |
|||
* [disco.gateway.packets](api/disco_gateway_packets.md) |
|||
* [disco.gateway.sharder](api/disco_gateway_sharder.md) |
|||
* [disco.gateway.ipc](api/disco_gateway_ipc.md) |
|||
* Types |
|||
* [disco.types.base](api/disco_types_base.md) |
|||
* [disco.types.channel](api/disco_types_channel.md) |
|||
* [disco.types.guild](api/disco_types_guild.md) |
|||
* [disco.types.invite](api/disco_types_invite.md) |
|||
* [disco.types.message](api/disco_types_message.md) |
|||
* [disco.types.permissions](api/disco_types_permissions.md) |
|||
* [disco.types.user](api/disco_types_user.md) |
|||
* [disco.types.voice](api/disco_types_voice.md) |
|||
* [disco.types.webhook](api/disco_types_webhook.md) |
|||
* Util |
|||
* [disco.util](api/disco_util.md) |
|||
* [disco.util.backdoor](api/disco_util_backdoor.md) |
|||
* [disco.util.chains](api/disco_util_chains.md) |
|||
* [disco.util.config](api/disco_util_config.md) |
|||
* [disco.util.functional](api/disco_util_functional.md) |
|||
* [disco.util.hashmap](api/disco_util_hashmap.md) |
|||
* [disco.util.limiter](api/disco_util_limiter.md) |
|||
* [disco.util.logging](api/disco_util_logging.md) |
|||
* [disco.util.sanitize](api/disco_util_sanitize.md) |
|||
* [disco.util.snowflake](api/disco_util_snowflake.md) |
|||
* [disco.util.token](api/disco_util_token.md) |
|||
* [disco.util.websocket](api/disco_util_websocket.md) |
|||
* Voice |
|||
* [disco.voice.client](api/disco_voice_client.md) |
|||
* [disco.voice.opus](api/disco_voice_opus.md) |
|||
* [disco.voice.packets](api/disco_voice_packets.md) |
|||
* [disco.voice.playable](api/disco_voice_playable.md) |
|||
* [disco.voice.player](api/disco_voice_player.md) |
|||
|
|||
|
|||
@ -1,150 +0,0 @@ |
|||
.. currentmodule:: disco |
|||
|
|||
API Reference |
|||
============= |
|||
|
|||
Version Information |
|||
------------------- |
|||
disco exports a top-level variable that can be used to introspect the current |
|||
version information for the installed package. |
|||
|
|||
.. data:: VERSION |
|||
|
|||
A string representation of the current version, in standard semantic |
|||
versioning format. E.g. ``'5.4.3-rc.2'`` |
|||
|
|||
|
|||
Client |
|||
------------ |
|||
|
|||
.. autoclass:: disco.client.Client |
|||
:members: |
|||
|
|||
|
|||
State |
|||
----- |
|||
|
|||
.. automodule:: disco.state |
|||
:members: |
|||
|
|||
|
|||
CLI |
|||
--- |
|||
|
|||
.. automodule:: disco.cli |
|||
:members: |
|||
|
|||
|
|||
Types |
|||
----- |
|||
|
|||
Channel |
|||
~~~~~~~ |
|||
|
|||
.. automodule:: disco.types.channel |
|||
:members: |
|||
|
|||
Guild |
|||
~~~~~ |
|||
|
|||
.. automodule:: disco.types.guild |
|||
:members: |
|||
|
|||
Message |
|||
~~~~~~~ |
|||
|
|||
.. automodule:: disco.types.message |
|||
:members: |
|||
|
|||
User |
|||
~~~~ |
|||
|
|||
.. automodule:: disco.types.user |
|||
:members: |
|||
|
|||
Voice |
|||
~~~~~ |
|||
|
|||
.. automodule:: disco.types.voice |
|||
:members: |
|||
|
|||
Invite |
|||
~~~~~~ |
|||
|
|||
.. automodule:: disco.types.invite |
|||
:members: |
|||
|
|||
Permissions |
|||
~~~~~~~~~~~ |
|||
|
|||
.. automodule:: disco.types.permissions |
|||
:members: |
|||
|
|||
|
|||
Bot Toolkit |
|||
----------- |
|||
|
|||
.. automodule:: disco.bot.bot |
|||
:members: |
|||
|
|||
Plugins |
|||
~~~~~~~ |
|||
|
|||
.. automodule:: disco.bot.plugin |
|||
:members: |
|||
|
|||
Commands |
|||
~~~~~~~~ |
|||
|
|||
.. automodule:: disco.bot.command |
|||
:members: |
|||
|
|||
Command Argument Parser |
|||
~~~~~~~~~~~~~~~~~~~~~~~ |
|||
|
|||
.. automodule:: disco.bot.parser |
|||
:members: |
|||
|
|||
|
|||
Gateway API |
|||
----------- |
|||
|
|||
GatewayClient |
|||
~~~~~~~~~~~~~ |
|||
|
|||
.. autoclass:: disco.gateway.client.GatewayClient |
|||
:members: |
|||
|
|||
Gateway Events |
|||
~~~~~~~~~~~~~~ |
|||
|
|||
.. automodule:: disco.gateway.events |
|||
:members: |
|||
|
|||
|
|||
REST API |
|||
-------- |
|||
|
|||
APIClient |
|||
~~~~~~~~~ |
|||
|
|||
.. autoclass:: disco.api.client.APIClient |
|||
:members: |
|||
:undoc-members: |
|||
|
|||
HTTP Utilities |
|||
~~~~~~~~~~~~~~ |
|||
.. autoclass:: disco.api.http.APIException |
|||
:members: |
|||
|
|||
.. autoclass:: disco.api.http.HTTPClient |
|||
:members: |
|||
|
|||
Ratelimit Utilities |
|||
~~~~~~~~~~~~~~~~~~~ |
|||
|
|||
.. autoclass:: disco.api.ratelimit.RouteState |
|||
:members: |
|||
|
|||
.. autoclass:: disco.api.ratelimit.RateLimiter |
|||
:members: |
|||
@ -0,0 +1,10 @@ |
|||
{ |
|||
"title": "Disco", |
|||
"plugins": ["prism", "-highlight", "hints"], |
|||
"pluginsConfig": { |
|||
"anchorjs": { |
|||
"placement": "left", |
|||
"visible": "always" |
|||
} |
|||
} |
|||
} |
|||
@ -0,0 +1,32 @@ |
|||
# Plugins |
|||
|
|||
Plugins are Disco are a core abstraction which attempt to encapsulate the functionality of your bot into contained modules. To boil it down, commands related to one another, or listeners that control the same functionality should be within the same Plugin. Although it's possible to call and pass data between Plugins, you should generally attempt to avoid it. |
|||
|
|||
## Plugin Lifecycle |
|||
|
|||
### Loading |
|||
|
|||
Plugins are loaded when the Bot is initially created, and when this happens the `Plugin.load` function is called. If the plugin is being reloaded, the call to this function will contain a dictionary of data returned by the previous `unload` call. Using this, you can pass data between loaded instances of your plugin to help aid in seamless reloads. Often plugins will require some level of configuration and setup before running, and this code can be inserted within an overridden version of the load function, as such: |
|||
|
|||
```python |
|||
class ExamplePlugin(Plugin): |
|||
def load(self, ctx): |
|||
super(ExamplePlugin, self).load(ctx) |
|||
setup_database() |
|||
self.data = ctx.get('data', {}) |
|||
``` |
|||
|
|||
The load function of a plugin is guaranteed to only be called once for the instance, when reloading a new instance of the plugin will be created. |
|||
|
|||
### Unloading |
|||
|
|||
Plugins are unloaded in multiple scenarios (shutdown, before a reload, or during an unload), and when this happens the `Plugin.unload` function is called. This function is passed one argument containing a dictionary, which (if the plugin wants) can be filled with information that a future iteration (in the case we're reloading) of the plugin can use to maintain state. Plugins may want to call or save data before being unloaded, and in this case they can override the unload function: |
|||
|
|||
```python |
|||
class ExamplePlugin(Plugin): |
|||
def unload(self, ctx): |
|||
ctx['data'] = self.data |
|||
super(ExamplePlugin, self).unload(ctx) |
|||
``` |
|||
|
|||
During the unload sequence all greenlets which the plugin owns (e.g. greenlets for command or listener callbacks, any spawned with `Plugin.spawn`) are terminated. In the case where command callbacks should continue execution past the unload point (e.g. in the case where a plugin reloads itself), you should pass `oob=True` to the `Plugin.command` decorator. |
|||
@ -0,0 +1,55 @@ |
|||
# Bot Tutorial |
|||
|
|||
Disco provides a built-in set of tools for building and running Discord bots which can be used to quickly and easily create integrations. Within this tutorial you'll be shown how to install Disco, write plugins, and run bots. This tutorial assumes you've already followed the [Installation Steps](../installation.md). |
|||
|
|||
## Creating a Bot |
|||
|
|||
The first step to creating bots is to actually register them on Discord itself. To do this, you'll need to be logged into your Discord account on the browser and then navigate to [My Apps](https://discordapp.com/developers/applications/me). Here you'll have the option to create a new application, and once created you can add a bot user (by clicking "Create a Bot User") to your application. Finally, you'll want to keep track of the bot user token which can be shown by clicking the "click to reveal" link next to the token field. |
|||
|
|||
Once you have a Discord bot account, you can then setup your workspace. For now we'll just need a folder (perhaps called `disco-tutorial`) with a few files in it: |
|||
|
|||
``` |
|||
disco-tutorial/ |
|||
config.yaml |
|||
plugins/ |
|||
tutorial.py |
|||
``` |
|||
|
|||
|
|||
Within the config file, paste the following template configuration and modify the token key to contain the token you obtained above: |
|||
|
|||
```yaml |
|||
token: 'MY_BOT_TOKEN_HERE' |
|||
|
|||
bot: |
|||
plugins: |
|||
- plugins.tutorial |
|||
``` |
|||
|
|||
Now, within the python file (`tutorial.py`), lets write some code: |
|||
|
|||
|
|||
```python |
|||
from disco.bot import Plugin |
|||
|
|||
|
|||
class TutorialPlugin(Plugin): |
|||
@Plugin.command('ping') |
|||
def command_ping(self, event): |
|||
event.msg.reply('Pong!') |
|||
``` |
|||
|
|||
And finally, we're ready to start and test the bot. We can do this by executing the following command from within our project directory: |
|||
|
|||
|
|||
```sh |
|||
python -m disco.cli --config config.yaml |
|||
``` |
|||
|
|||
If all is successful, you can then test your bot by mentioning it with the command, like so: |
|||
|
|||
``` |
|||
@tutorial#1234 ping |
|||
``` |
|||
|
|||
At this point, you've achieved the creation and setup of a very simple bot. Now lets work on understanding and working with more Disco features. |
|||
@ -1,12 +1,20 @@ |
|||
#!/bin/bash |
|||
rm -rf _build |
|||
make html |
|||
|
|||
pushd _build/html |
|||
git init |
|||
git config user.name 'Autodoc' |
|||
git config user.email '<>' |
|||
git add . |
|||
git commit -m "Autogenerated documentation" |
|||
git push --force --quiet "https://${GH_TOKEN}@github.com/b1naryth1ef/disco" master:gh-pages |
|||
echo "Building Autogenerated API Docs" |
|||
pushd .. |
|||
python -m biblio.cli ../disco/.biblio.yaml |
|||
popd |
|||
|
|||
echo "Running Gitbook Build" |
|||
gitbook build |
|||
|
|||
if [ ! -z "${GH_TOKEN:-}" ]; then |
|||
echo "Deploying to Github Pages" |
|||
pushd _book/ |
|||
git init |
|||
git config user.name "AutoDoc" |
|||
git config user.email "<>" |
|||
git add . |
|||
git commit -m "Generated Documentation" |
|||
git push --force --quiet "https://${GH_TOKEN}@github.com/b1naryth1ef/disco" master:gh-pages |
|||
popd |
|||
fi |
|||
|
|||
@ -1,343 +0,0 @@ |
|||
# -*- coding: utf-8 -*- |
|||
# |
|||
# disco documentation build configuration file, created by |
|||
# sphinx-quickstart on Tue Oct 4 22:15:06 2016. |
|||
# |
|||
# This file is execfile()d with the current directory set to its |
|||
# containing dir. |
|||
# |
|||
# Note that not all possible configuration values are present in this |
|||
# autogenerated file. |
|||
# |
|||
# All configuration values have a default; values that are commented out |
|||
# serve to show the default. |
|||
|
|||
# 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. |
|||
# |
|||
import os |
|||
import sys |
|||
sys.path.insert(0, os.path.abspath('../')) |
|||
|
|||
# -- General configuration ------------------------------------------------ |
|||
|
|||
# If your documentation needs a minimal Sphinx version, state it here. |
|||
# |
|||
# needs_sphinx = '1.0' |
|||
|
|||
# Add any Sphinx extension module names here, as strings. They can be |
|||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
|||
# ones. |
|||
extensions = [ |
|||
'sphinx.ext.autodoc', |
|||
'sphinx.ext.coverage', |
|||
'sphinx.ext.viewcode', |
|||
'sphinx.ext.napoleon' |
|||
] |
|||
|
|||
# Add any paths that contain templates here, relative to this directory. |
|||
templates_path = ['_templates'] |
|||
|
|||
# The suffix(es) of source filenames. |
|||
# You can specify multiple suffix as a list of string: |
|||
# |
|||
# source_suffix = ['.rst', '.md'] |
|||
source_suffix = '.rst' |
|||
|
|||
# The encoding of source files. |
|||
# |
|||
# source_encoding = 'utf-8-sig' |
|||
|
|||
# The master toctree document. |
|||
master_doc = 'index' |
|||
|
|||
# General information about the project. |
|||
project = u'disco' |
|||
copyright = u'2016, Andrei Zbikowski' |
|||
author = u'Andrei Zbikowski' |
|||
|
|||
# The version info for the project you're documenting, acts as replacement for |
|||
# |version| and |release|, also used in various other places throughout the |
|||
# built documents. |
|||
# |
|||
# The short X.Y version. |
|||
version = u'0.0.1' |
|||
# The full version, including alpha/beta/rc tags. |
|||
release = u'0.0.1' |
|||
|
|||
# The language for content autogenerated by Sphinx. Refer to documentation |
|||
# for a list of supported languages. |
|||
# |
|||
# This is also used if you do content translation via gettext catalogs. |
|||
# Usually you set "language" from the command line for these cases. |
|||
language = None |
|||
|
|||
# There are two options for replacing |today|: either, you set today to some |
|||
# non-false value, then it is used: |
|||
# |
|||
# today = '' |
|||
# |
|||
# Else, today_fmt is used as the format for a strftime call. |
|||
# |
|||
# today_fmt = '%B %d, %Y' |
|||
|
|||
# List of patterns, relative to source directory, that match files and |
|||
# directories to ignore when looking for source files. |
|||
# This patterns also effect to html_static_path and html_extra_path |
|||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
|||
|
|||
# The reST default role (used for this markup: `text`) to use for all |
|||
# documents. |
|||
# |
|||
# default_role = None |
|||
|
|||
# If true, '()' will be appended to :func: etc. cross-reference text. |
|||
# |
|||
# add_function_parentheses = True |
|||
|
|||
# If true, the current module name will be prepended to all description |
|||
# unit titles (such as .. function::). |
|||
# |
|||
# add_module_names = True |
|||
|
|||
# If true, sectionauthor and moduleauthor directives will be shown in the |
|||
# output. They are ignored by default. |
|||
# |
|||
# show_authors = False |
|||
|
|||
# The name of the Pygments (syntax highlighting) style to use. |
|||
pygments_style = 'sphinx' |
|||
|
|||
# A list of ignored prefixes for module index sorting. |
|||
# modindex_common_prefix = [] |
|||
|
|||
# If true, keep warnings as "system message" paragraphs in the built documents. |
|||
# keep_warnings = False |
|||
|
|||
# If true, `todo` and `todoList` produce output, else they produce nothing. |
|||
todo_include_todos = False |
|||
|
|||
|
|||
# -- Options for HTML output ---------------------------------------------- |
|||
|
|||
# The theme to use for HTML and HTML Help pages. See the documentation for |
|||
# a list of builtin themes. |
|||
# |
|||
html_theme = 'sphinx_rtd_theme' |
|||
|
|||
# Theme options are theme-specific and customize the look and feel of a theme |
|||
# further. For a list of options available for each theme, see the |
|||
# documentation. |
|||
# |
|||
# html_theme_options = {} |
|||
|
|||
# Add any paths that contain custom themes here, relative to this directory. |
|||
# html_theme_path = [] |
|||
|
|||
# The name for this set of Sphinx documents. |
|||
# "<project> v<release> documentation" by default. |
|||
# |
|||
# html_title = u'disco v0.0.1' |
|||
|
|||
# A shorter title for the navigation bar. Default is the same as html_title. |
|||
# |
|||
# html_short_title = None |
|||
|
|||
# The name of an image file (relative to this directory) to place at the top |
|||
# of the sidebar. |
|||
# |
|||
# html_logo = None |
|||
|
|||
# The name of an image file (relative to this directory) to use as a favicon of |
|||
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
|||
# pixels large. |
|||
# |
|||
# html_favicon = None |
|||
|
|||
# Add any paths that contain custom static files (such as style sheets) here, |
|||
# relative to this directory. They are copied after the builtin static files, |
|||
# so a file named "default.css" will overwrite the builtin "default.css". |
|||
html_static_path = ['_static'] |
|||
|
|||
# Add any extra paths that contain custom files (such as robots.txt or |
|||
# .htaccess) here, relative to this directory. These files are copied |
|||
# directly to the root of the documentation. |
|||
# |
|||
# html_extra_path = [] |
|||
|
|||
# If not None, a 'Last updated on:' timestamp is inserted at every page |
|||
# bottom, using the given strftime format. |
|||
# The empty string is equivalent to '%b %d, %Y'. |
|||
# |
|||
# html_last_updated_fmt = None |
|||
|
|||
# If true, SmartyPants will be used to convert quotes and dashes to |
|||
# typographically correct entities. |
|||
# |
|||
# html_use_smartypants = True |
|||
|
|||
# Custom sidebar templates, maps document names to template names. |
|||
# |
|||
# html_sidebars = {} |
|||
|
|||
# Additional templates that should be rendered to pages, maps page names to |
|||
# template names. |
|||
# |
|||
# html_additional_pages = {} |
|||
|
|||
# If false, no module index is generated. |
|||
# |
|||
# html_domain_indices = True |
|||
|
|||
# If false, no index is generated. |
|||
# |
|||
# html_use_index = True |
|||
|
|||
# If true, the index is split into individual pages for each letter. |
|||
# |
|||
# html_split_index = False |
|||
|
|||
# If true, links to the reST sources are added to the pages. |
|||
# |
|||
# html_show_sourcelink = True |
|||
|
|||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
|||
# |
|||
# html_show_sphinx = True |
|||
|
|||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
|||
# |
|||
# html_show_copyright = True |
|||
|
|||
# If true, an OpenSearch description file will be output, and all pages will |
|||
# contain a <link> tag referring to it. The value of this option must be the |
|||
# base URL from which the finished HTML is served. |
|||
# |
|||
# html_use_opensearch = '' |
|||
|
|||
# This is the file name suffix for HTML files (e.g. ".xhtml"). |
|||
# html_file_suffix = None |
|||
|
|||
# Language to be used for generating the HTML full-text search index. |
|||
# Sphinx supports the following languages: |
|||
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' |
|||
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' |
|||
# |
|||
# html_search_language = 'en' |
|||
|
|||
# A dictionary with options for the search language support, empty by default. |
|||
# 'ja' uses this config value. |
|||
# 'zh' user can custom change `jieba` dictionary path. |
|||
# |
|||
# html_search_options = {'type': 'default'} |
|||
|
|||
# The name of a javascript file (relative to the configuration directory) that |
|||
# implements a search results scorer. If empty, the default will be used. |
|||
# |
|||
# html_search_scorer = 'scorer.js' |
|||
|
|||
# Output file base name for HTML help builder. |
|||
htmlhelp_basename = 'discodoc' |
|||
|
|||
# -- Options for LaTeX output --------------------------------------------- |
|||
|
|||
latex_elements = { |
|||
# The paper size ('letterpaper' or 'a4paper'). |
|||
# |
|||
# 'papersize': 'letterpaper', |
|||
|
|||
# The font size ('10pt', '11pt' or '12pt'). |
|||
# |
|||
# 'pointsize': '10pt', |
|||
|
|||
# Additional stuff for the LaTeX preamble. |
|||
# |
|||
# 'preamble': '', |
|||
|
|||
# Latex figure (float) alignment |
|||
# |
|||
# 'figure_align': 'htbp', |
|||
} |
|||
|
|||
# Grouping the document tree into LaTeX files. List of tuples |
|||
# (source start file, target name, title, |
|||
# author, documentclass [howto, manual, or own class]). |
|||
latex_documents = [ |
|||
(master_doc, 'disco.tex', u'disco Documentation', |
|||
u'Andrei Zbikowski', 'manual'), |
|||
] |
|||
|
|||
# The name of an image file (relative to this directory) to place at the top of |
|||
# the title page. |
|||
# |
|||
# latex_logo = None |
|||
|
|||
# For "manual" documents, if this is true, then toplevel headings are parts, |
|||
# not chapters. |
|||
# |
|||
# latex_use_parts = False |
|||
|
|||
# If true, show page references after internal links. |
|||
# |
|||
# latex_show_pagerefs = False |
|||
|
|||
# If true, show URL addresses after external links. |
|||
# |
|||
# latex_show_urls = False |
|||
|
|||
# Documents to append as an appendix to all manuals. |
|||
# |
|||
# latex_appendices = [] |
|||
|
|||
# It false, will not define \strong, \code, itleref, \crossref ... but only |
|||
# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added |
|||
# packages. |
|||
# |
|||
# latex_keep_old_macro_names = True |
|||
|
|||
# If false, no module index is generated. |
|||
# |
|||
# latex_domain_indices = True |
|||
|
|||
|
|||
# -- Options for manual page output --------------------------------------- |
|||
|
|||
# One entry per manual page. List of tuples |
|||
# (source start file, name, description, authors, manual section). |
|||
man_pages = [ |
|||
(master_doc, 'disco', u'disco Documentation', |
|||
[author], 1) |
|||
] |
|||
|
|||
# If true, show URL addresses after external links. |
|||
# |
|||
# man_show_urls = False |
|||
|
|||
|
|||
# -- Options for Texinfo output ------------------------------------------- |
|||
|
|||
# Grouping the document tree into Texinfo files. List of tuples |
|||
# (source start file, target name, title, author, |
|||
# dir menu entry, description, category) |
|||
texinfo_documents = [ |
|||
(master_doc, 'disco', u'disco Documentation', |
|||
author, 'disco', 'One line description of project.', |
|||
'Miscellaneous'), |
|||
] |
|||
|
|||
# Documents to append as an appendix to all manuals. |
|||
# |
|||
# texinfo_appendices = [] |
|||
|
|||
# If false, no module index is generated. |
|||
# |
|||
# texinfo_domain_indices = True |
|||
|
|||
# How to display URL addresses: 'footnote', 'no', or 'inline'. |
|||
# |
|||
# texinfo_show_urls = 'footnote' |
|||
|
|||
# If true, do not generate a @detailmenu in the "Top" node's menu. |
|||
# |
|||
# texinfo_no_detailmenu = False |
|||
@ -1,28 +0,0 @@ |
|||
disco |
|||
================================= |
|||
|
|||
Disco is a simple and extendable library for the `Discord API <https://discordapp.com/developers/docs/intro>`_. |
|||
|
|||
* Expressive, functional interface that gets out of the way |
|||
* Built for high-performance and efficiency |
|||
* Configurable and modular, take the bits you need |
|||
* Full support for Python 2.x/3.x |
|||
* Evented networking and IO using Gevent |
|||
|
|||
Contents: |
|||
--------- |
|||
|
|||
.. toctree:: |
|||
:maxdepth: 2 |
|||
|
|||
tutorial |
|||
api |
|||
utilities |
|||
|
|||
Indices and tables |
|||
================== |
|||
|
|||
* :ref:`genindex` |
|||
* :ref:`modindex` |
|||
* :ref:`search` |
|||
|
|||
@ -0,0 +1,27 @@ |
|||
# Installation and Setup |
|||
|
|||
{% hint style='tip' %} |
|||
If you are a new Python developer, or are unsure what pip even is, try starting [here](https://packaging.python.org/installing/). |
|||
{% endhint %} |
|||
|
|||
The easiest way to install the base version of Disco is through Python's [pip](https://pip.pypa.io/en/stable/) utility. To simply install the most minimal version of Disco, simply run: |
|||
|
|||
```sh |
|||
pip install disco-py |
|||
``` |
|||
|
|||
## Optional Dependencies |
|||
|
|||
Disco provides a set of optional dependencies which add various bits of functionality or performance changes when installed. These can all be installed in a similar fashion to Disco; |
|||
|
|||
```sh |
|||
pip install disco[performance] |
|||
``` |
|||
|
|||
| Name | Explanation | Versions | |
|||
|------|-------------|----------| |
|||
| voice | Adds functionality required to connect and use voice | Both | |
|||
| music | Adds the ability to stream and play music from various third party sites | Both | |
|||
| performance | Adds a faster JSON parser (ujson) and an ETF encoding parser | 2.x Only | |
|||
| sharding | Adds a library which is required to enable auto-sharding | 2.x Only | |
|||
| docs | Adds a library required to build this documentation | Both | |
|||
@ -1,281 +0,0 @@ |
|||
@ECHO OFF |
|||
|
|||
REM Command file for Sphinx documentation |
|||
|
|||
if "%SPHINXBUILD%" == "" ( |
|||
set SPHINXBUILD=sphinx-build |
|||
) |
|||
set BUILDDIR=_build |
|||
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . |
|||
set I18NSPHINXOPTS=%SPHINXOPTS% . |
|||
if NOT "%PAPER%" == "" ( |
|||
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% |
|||
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% |
|||
) |
|||
|
|||
if "%1" == "" goto help |
|||
|
|||
if "%1" == "help" ( |
|||
:help |
|||
echo.Please use `make ^<target^>` where ^<target^> is one of |
|||
echo. html to make standalone HTML files |
|||
echo. dirhtml to make HTML files named index.html in directories |
|||
echo. singlehtml to make a single large HTML file |
|||
echo. pickle to make pickle files |
|||
echo. json to make JSON files |
|||
echo. htmlhelp to make HTML files and a HTML help project |
|||
echo. qthelp to make HTML files and a qthelp project |
|||
echo. devhelp to make HTML files and a Devhelp project |
|||
echo. epub to make an epub |
|||
echo. epub3 to make an epub3 |
|||
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter |
|||
echo. text to make text files |
|||
echo. man to make manual pages |
|||
echo. texinfo to make Texinfo files |
|||
echo. gettext to make PO message catalogs |
|||
echo. changes to make an overview over all changed/added/deprecated items |
|||
echo. xml to make Docutils-native XML files |
|||
echo. pseudoxml to make pseudoxml-XML files for display purposes |
|||
echo. linkcheck to check all external links for integrity |
|||
echo. doctest to run all doctests embedded in the documentation if enabled |
|||
echo. coverage to run coverage check of the documentation if enabled |
|||
echo. dummy to check syntax errors of document sources |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "clean" ( |
|||
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i |
|||
del /q /s %BUILDDIR%\* |
|||
goto end |
|||
) |
|||
|
|||
|
|||
REM Check if sphinx-build is available and fallback to Python version if any |
|||
%SPHINXBUILD% 1>NUL 2>NUL |
|||
if errorlevel 9009 goto sphinx_python |
|||
goto sphinx_ok |
|||
|
|||
:sphinx_python |
|||
|
|||
set SPHINXBUILD=python -m sphinx.__init__ |
|||
%SPHINXBUILD% 2> nul |
|||
if errorlevel 9009 ( |
|||
echo. |
|||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx |
|||
echo.installed, then set the SPHINXBUILD environment variable to point |
|||
echo.to the full path of the 'sphinx-build' executable. Alternatively you |
|||
echo.may add the Sphinx directory to PATH. |
|||
echo. |
|||
echo.If you don't have Sphinx installed, grab it from |
|||
echo.http://sphinx-doc.org/ |
|||
exit /b 1 |
|||
) |
|||
|
|||
:sphinx_ok |
|||
|
|||
|
|||
if "%1" == "html" ( |
|||
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Build finished. The HTML pages are in %BUILDDIR%/html. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "dirhtml" ( |
|||
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "singlehtml" ( |
|||
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "pickle" ( |
|||
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Build finished; now you can process the pickle files. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "json" ( |
|||
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Build finished; now you can process the JSON files. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "htmlhelp" ( |
|||
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Build finished; now you can run HTML Help Workshop with the ^ |
|||
.hhp project file in %BUILDDIR%/htmlhelp. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "qthelp" ( |
|||
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Build finished; now you can run "qcollectiongenerator" with the ^ |
|||
.qhcp project file in %BUILDDIR%/qthelp, like this: |
|||
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\disco.qhcp |
|||
echo.To view the help file: |
|||
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\disco.ghc |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "devhelp" ( |
|||
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Build finished. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "epub" ( |
|||
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Build finished. The epub file is in %BUILDDIR%/epub. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "epub3" ( |
|||
%SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3 |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Build finished. The epub3 file is in %BUILDDIR%/epub3. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "latex" ( |
|||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "latexpdf" ( |
|||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex |
|||
cd %BUILDDIR%/latex |
|||
make all-pdf |
|||
cd %~dp0 |
|||
echo. |
|||
echo.Build finished; the PDF files are in %BUILDDIR%/latex. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "latexpdfja" ( |
|||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex |
|||
cd %BUILDDIR%/latex |
|||
make all-pdf-ja |
|||
cd %~dp0 |
|||
echo. |
|||
echo.Build finished; the PDF files are in %BUILDDIR%/latex. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "text" ( |
|||
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Build finished. The text files are in %BUILDDIR%/text. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "man" ( |
|||
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Build finished. The manual pages are in %BUILDDIR%/man. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "texinfo" ( |
|||
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "gettext" ( |
|||
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Build finished. The message catalogs are in %BUILDDIR%/locale. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "changes" ( |
|||
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.The overview file is in %BUILDDIR%/changes. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "linkcheck" ( |
|||
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Link check complete; look for any errors in the above output ^ |
|||
or in %BUILDDIR%/linkcheck/output.txt. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "doctest" ( |
|||
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Testing of doctests in the sources finished, look at the ^ |
|||
results in %BUILDDIR%/doctest/output.txt. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "coverage" ( |
|||
%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Testing of coverage in the sources finished, look at the ^ |
|||
results in %BUILDDIR%/coverage/python.txt. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "xml" ( |
|||
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Build finished. The XML files are in %BUILDDIR%/xml. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "pseudoxml" ( |
|||
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. |
|||
goto end |
|||
) |
|||
|
|||
if "%1" == "dummy" ( |
|||
%SPHINXBUILD% -b dummy %ALLSPHINXOPTS% %BUILDDIR%/dummy |
|||
if errorlevel 1 exit /b 1 |
|||
echo. |
|||
echo.Build finished. Dummy builder generates no files. |
|||
goto end |
|||
) |
|||
|
|||
:end |
|||
@ -1,5 +0,0 @@ |
|||
.. currentmodule:: disco |
|||
|
|||
Tutorial |
|||
======== |
|||
|
|||
@ -1,27 +0,0 @@ |
|||
.. currentmodule:: disco |
|||
|
|||
Utilities |
|||
========= |
|||
|
|||
This section details information about various utilities provided in the disco |
|||
package, which aid the development and runtime management of disco clients/bots. |
|||
Generally these utilties are situational, and can be enabled depending on |
|||
various scenarious developers and users may find themselves in. |
|||
|
|||
Manhole |
|||
------- |
|||
|
|||
The manhole utilty is a backdoor server that allows opening a interactive REPL |
|||
while the client is running. This can be very useful for attaching and |
|||
inspecting runtime state, without distribing the normal client operations. To |
|||
enable the backdoor, simply set the |
|||
:attr:`disco.client.ClientConfig.manhole_enable` setting, and tweak |
|||
:attr:`disco.client.ClientConfig.manhole_bind` settings based on the connection |
|||
parameters you'd like. |
|||
|
|||
It's recommended you connect to the manhole via ``rlwrap`` and ``netcat``, which |
|||
will give a proper TTY-like readline experience. For example: |
|||
|
|||
.. sourcecode:: bash |
|||
|
|||
rlwrap netcat localhost 8484 |
|||
Loading…
Reference in new issue