Andrei
9 years ago
21 changed files with 1581 additions and 60 deletions
@ -1,3 +1,4 @@ |
|||
build/ |
|||
dist/ |
|||
disco.egg-info/ |
|||
docs/_build |
|||
|
|||
@ -0,0 +1,225 @@ |
|||
# 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,343 @@ |
|||
# -*- 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.githubpages', |
|||
] |
|||
|
|||
# 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 |
|||
@ -0,0 +1,38 @@ |
|||
disco.api package |
|||
================= |
|||
|
|||
Submodules |
|||
---------- |
|||
|
|||
disco.api.client module |
|||
----------------------- |
|||
|
|||
.. automodule:: disco.api.client |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.api.http module |
|||
--------------------- |
|||
|
|||
.. automodule:: disco.api.http |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.api.ratelimit module |
|||
-------------------------- |
|||
|
|||
.. automodule:: disco.api.ratelimit |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
|
|||
Module contents |
|||
--------------- |
|||
|
|||
.. automodule:: disco.api |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
@ -0,0 +1,46 @@ |
|||
disco.bot package |
|||
================= |
|||
|
|||
Submodules |
|||
---------- |
|||
|
|||
disco.bot.bot module |
|||
-------------------- |
|||
|
|||
.. automodule:: disco.bot.bot |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.bot.command module |
|||
------------------------ |
|||
|
|||
.. automodule:: disco.bot.command |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.bot.parser module |
|||
----------------------- |
|||
|
|||
.. automodule:: disco.bot.parser |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.bot.plugin module |
|||
----------------------- |
|||
|
|||
.. automodule:: disco.bot.plugin |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
|
|||
Module contents |
|||
--------------- |
|||
|
|||
.. automodule:: disco.bot |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
@ -0,0 +1,38 @@ |
|||
disco.gateway package |
|||
===================== |
|||
|
|||
Submodules |
|||
---------- |
|||
|
|||
disco.gateway.client module |
|||
--------------------------- |
|||
|
|||
.. automodule:: disco.gateway.client |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.gateway.events module |
|||
--------------------------- |
|||
|
|||
.. automodule:: disco.gateway.events |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.gateway.packets module |
|||
---------------------------- |
|||
|
|||
.. automodule:: disco.gateway.packets |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
|
|||
Module contents |
|||
--------------- |
|||
|
|||
.. automodule:: disco.gateway |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
@ -0,0 +1,50 @@ |
|||
disco package |
|||
============= |
|||
|
|||
Subpackages |
|||
----------- |
|||
|
|||
.. toctree:: |
|||
|
|||
disco.api |
|||
disco.bot |
|||
disco.gateway |
|||
disco.types |
|||
disco.util |
|||
disco.voice |
|||
|
|||
Submodules |
|||
---------- |
|||
|
|||
disco.cli module |
|||
---------------- |
|||
|
|||
.. automodule:: disco.cli |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.client module |
|||
------------------- |
|||
|
|||
.. automodule:: disco.client |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.state module |
|||
------------------ |
|||
|
|||
.. automodule:: disco.state |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
|
|||
Module contents |
|||
--------------- |
|||
|
|||
.. automodule:: disco |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
@ -0,0 +1,78 @@ |
|||
disco.types package |
|||
=================== |
|||
|
|||
Submodules |
|||
---------- |
|||
|
|||
disco.types.base module |
|||
----------------------- |
|||
|
|||
.. automodule:: disco.types.base |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.types.channel module |
|||
-------------------------- |
|||
|
|||
.. automodule:: disco.types.channel |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.types.guild module |
|||
------------------------ |
|||
|
|||
.. automodule:: disco.types.guild |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.types.invite module |
|||
------------------------- |
|||
|
|||
.. automodule:: disco.types.invite |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.types.message module |
|||
-------------------------- |
|||
|
|||
.. automodule:: disco.types.message |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.types.permissions module |
|||
------------------------------ |
|||
|
|||
.. automodule:: disco.types.permissions |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.types.user module |
|||
----------------------- |
|||
|
|||
.. automodule:: disco.types.user |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.types.voice module |
|||
------------------------ |
|||
|
|||
.. automodule:: disco.types.voice |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
|
|||
Module contents |
|||
--------------- |
|||
|
|||
.. automodule:: disco.types |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
@ -0,0 +1,62 @@ |
|||
disco.util package |
|||
================== |
|||
|
|||
Submodules |
|||
---------- |
|||
|
|||
disco.util.cache module |
|||
----------------------- |
|||
|
|||
.. automodule:: disco.util.cache |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.util.json module |
|||
---------------------- |
|||
|
|||
.. automodule:: disco.util.json |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.util.logging module |
|||
------------------------- |
|||
|
|||
.. automodule:: disco.util.logging |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.util.token module |
|||
----------------------- |
|||
|
|||
.. automodule:: disco.util.token |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.util.types module |
|||
----------------------- |
|||
|
|||
.. automodule:: disco.util.types |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.util.websocket module |
|||
--------------------------- |
|||
|
|||
.. automodule:: disco.util.websocket |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
|
|||
Module contents |
|||
--------------- |
|||
|
|||
.. automodule:: disco.util |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
@ -0,0 +1,30 @@ |
|||
disco.voice package |
|||
=================== |
|||
|
|||
Submodules |
|||
---------- |
|||
|
|||
disco.voice.client module |
|||
------------------------- |
|||
|
|||
.. automodule:: disco.voice.client |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
disco.voice.packets module |
|||
-------------------------- |
|||
|
|||
.. automodule:: disco.voice.packets |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
|
|||
|
|||
Module contents |
|||
--------------- |
|||
|
|||
.. automodule:: disco.voice |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
@ -0,0 +1,22 @@ |
|||
.. disco documentation master file, created by |
|||
sphinx-quickstart on Tue Oct 4 22:15:06 2016. |
|||
You can adapt this file completely to your liking, but it should at least |
|||
contain the root `toctree` directive. |
|||
|
|||
Welcome to disco's documentation! |
|||
================================= |
|||
|
|||
Contents: |
|||
|
|||
.. toctree:: |
|||
:maxdepth: 2 |
|||
|
|||
|
|||
|
|||
Indices and tables |
|||
================== |
|||
|
|||
* :ref:`genindex` |
|||
* :ref:`modindex` |
|||
* :ref:`search` |
|||
|
|||
@ -0,0 +1,281 @@ |
|||
@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 |
|||
@ -0,0 +1,7 @@ |
|||
disco |
|||
===== |
|||
|
|||
.. toctree:: |
|||
:maxdepth: 4 |
|||
|
|||
disco |
|||
@ -0,0 +1,7 @@ |
|||
setup module |
|||
============ |
|||
|
|||
.. automodule:: setup |
|||
:members: |
|||
:undoc-members: |
|||
:show-inheritance: |
|||
Loading…
Reference in new issue