diff --git a/.gitignore b/.gitignore index 924e52e..9736a95 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ .coverage # Build remnants. +html dist build _build diff --git a/asterisk/agi.py b/asterisk/agi.py index 512ed03..9e8ce41 100755 --- a/asterisk/agi.py +++ b/asterisk/agi.py @@ -1,8 +1,9 @@ #!/usr/bin/env python2 # vim: set et sw=4: -"""agi - -This module contains functions and classes to implment AGI scripts in python. +""" +.. module:: agi + :synopsis: This module contains functions and classes to implment AGI scripts in python. + pyvr {'agi_callerid' : 'mars.putland.int', @@ -17,6 +18,8 @@ pyvr 'agi_request' : 'pyst', 'agi_type' : 'IAX'} +Specification +------------- """ import sys diff --git a/asterisk/agitb.py b/asterisk/agitb.py index a712194..cdd3be9 100644 --- a/asterisk/agitb.py +++ b/asterisk/agitb.py @@ -1,20 +1,27 @@ -"""More comprehensive traceback formatting for Python scripts. +""" +.. module:: agitb + :synopsis: More comprehensive traceback formatting for Python scripts. + +Example +------- To enable this module, do: - import asterisk.agitb, asterisk.agi - asterisk.agitb.enable(display = False, logdir = '/var/log/asterisk/') +.. code-block:: python - agi = asterisk.agi.AGI() - asterisk.agitb.enable(agi, False, '/var/log/asterisk') + import asterisk.agitb, asterisk.agi + asterisk.agitb.enable(display = False, logdir = '/var/log/asterisk/') + + agi = asterisk.agi.AGI() + asterisk.agitb.enable(agi, False, '/var/log/asterisk') at the top of your script. The optional arguments to enable() are: - agi - the agi handle to write verbose messages to - display - if true, tracebacks are displayed on the asterisk console - (used with the agi option) - logdir - if set, tracebacks are written to files in this directory - context - number of lines of source code to show for each stack frame +* agi - the agi handle to write verbose messages to +* display - if true, tracebacks are displayed on the asterisk console + (used with the agi option) +* logdir - if set, tracebacks are written to files in this directory +* context - number of lines of source code to show for each stack frame By default, tracebacks are displayed but not saved, and the context is 5 lines. @@ -27,6 +34,9 @@ for you, call agitb.handler(). The optional argument to handler() is a If you do not pass anything to handler() it will use sys.exc_info(). This script was adapted from Ka-Ping Yee's cgitb. + +Specification +------------- """ __author__ = 'Matthew Nicholson' diff --git a/asterisk/config.py b/asterisk/config.py index b86a9ae..7c53b0b 100644 --- a/asterisk/config.py +++ b/asterisk/config.py @@ -1,13 +1,19 @@ #!/usr/bin/env python # vim: set expandtab: """ -Parse Asterisk configuration files. +.. module:: config + :synopsis: Parse Asterisk configuration files. This module provides parsing functionality for asterisk config files. +Example +---------- + +.. code-block:: python + import asterisk.config import sys - + # load and parse the config file try: config = asterisk.config.Config('/etc/asterisk/extensions.conf') @@ -17,13 +23,17 @@ This module provides parsing functionality for asterisk config files. except IOError as e: print "Error opening file: %s" % e.strerror sys.exit(1) - + # print our parsed output for category in config.categories: print '[%s]' % category.name # print the current category for item in category.items: print ' %s = %s' % (item.name, item.value) + + +Specification +------------- """ import sys diff --git a/asterisk/fastagi.py b/asterisk/fastagi.py index db76608..2e137fd 100755 --- a/asterisk/fastagi.py +++ b/asterisk/fastagi.py @@ -1,9 +1,17 @@ #!/usr/bin/env python -# FastAGI service for Asterisk -# Requires modified pyst2 to support reading stdin/out/err -# -# Copyright 2011 VOICE1, LLC -# By: Ben Davis + +""" +.. module:: fastagi + :synopsis: FastAGI service for Asterisk + +Requires modified pyst2 to support reading stdin/out/err + + Copyright 2011 VOICE1, LLC + By: Ben Davis + +Specification +------------- +""" import sys import SocketServer diff --git a/asterisk/manager.py b/asterisk/manager.py index 561b3f5..edc4cdd 100644 --- a/asterisk/manager.py +++ b/asterisk/manager.py @@ -2,10 +2,16 @@ # vim: set expandtab shiftwidth=4: """ -Python Interface for Asterisk Manager +.. module:: manager + :synopsis: Python Interface for Asterisk Manager This module provides a Python API for interfacing with the asterisk manager. +Example +------- + +.. code-block:: python + import asterisk.manager import sys @@ -50,6 +56,9 @@ Remember all header, response, and event names are case sensitive. Not all manager actions are implmented as of yet, feel free to add them and submit patches. + +Specification +------------- """ import sys diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..377f0d2 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,216 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = ../ + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.PHONY: help +help: + @echo "Please use \`make ' where 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 " 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)" + +.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/pyst2.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pyst2.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/pyst2" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pyst2" + @echo "# devhelp" + +.PHONY: epub +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +.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." diff --git a/docs/source/agi.rst b/docs/source/agi.rst new file mode 100644 index 0000000..151586f --- /dev/null +++ b/docs/source/agi.rst @@ -0,0 +1,6 @@ +AGI +========================= + +.. automodule:: asterisk.agi + :members: + diff --git a/docs/source/agitb.rst b/docs/source/agitb.rst new file mode 100644 index 0000000..90c9471 --- /dev/null +++ b/docs/source/agitb.rst @@ -0,0 +1,6 @@ +AGITB +========================= + +.. automodule:: asterisk.agitb + :members: + diff --git a/docs/source/changes.rst b/docs/source/changes.rst new file mode 100644 index 0000000..e815f47 --- /dev/null +++ b/docs/source/changes.rst @@ -0,0 +1,5 @@ +Changes +******* + +.. include:: ../../CHANGELOG + diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..d8c3d7f --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,294 @@ +# -*- coding: utf-8 -*- +# +# pyst2 documentation build configuration file, created by +# sphinx-quickstart on Mon Mar 7 10:41:33 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. + +import sys +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('../../')) + +# -- 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.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.ifconfig', + 'sphinx.ext.viewcode', +] + +# 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'pyst2' +copyright = u'2016, Randall Degges' +author = u'Randall Degges' + +# 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.4.9' +# The full version, including alpha/beta/rc tags. +release = u'0.4.9' + +# 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. +exclude_patterns = [] + +# 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 = True + + +# -- 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 = 'alabaster' + +# 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. If None, it defaults to +# " v documentation". +#html_title = None + +# 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 '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# 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 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' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +#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 = 'pyst2doc' + +# -- 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, 'pyst2.tex', u'pyst2 Documentation', + u'Randall Degges', '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 = [] + +# 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, 'pyst2', u'pyst2 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, 'pyst2', u'pyst2 Documentation', + author, 'pyst2', '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 + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/source/config.rst b/docs/source/config.rst new file mode 100644 index 0000000..f9b03e9 --- /dev/null +++ b/docs/source/config.rst @@ -0,0 +1,6 @@ +Config +========================= + +.. automodule:: asterisk.config + :members: + diff --git a/docs/source/fastagi.rst b/docs/source/fastagi.rst new file mode 100644 index 0000000..753e25d --- /dev/null +++ b/docs/source/fastagi.rst @@ -0,0 +1,6 @@ +fastAGI +========================= + +.. automodule:: asterisk.fastagi + :members: + diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..196309b --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,29 @@ +.. pyst2 documentation master file, created by + sphinx-quickstart on Mon Mar 7 10:41:33 2016. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to pyst2's documentation! +================================= + +Contents: + +.. toctree:: + :maxdepth: 2 + + readme + agi + agitb + config + fastagi + manager + + changes + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/docs/source/manager.rst b/docs/source/manager.rst new file mode 100644 index 0000000..cbf7d39 --- /dev/null +++ b/docs/source/manager.rst @@ -0,0 +1,6 @@ +Manager +========================= + +.. automodule:: asterisk.manager + :members: + diff --git a/docs/source/readme.rst b/docs/source/readme.rst new file mode 100644 index 0000000..a6210d3 --- /dev/null +++ b/docs/source/readme.rst @@ -0,0 +1 @@ +.. include:: ../../README.rst diff --git a/doctrees/agi.doctree b/doctrees/agi.doctree new file mode 100644 index 0000000..a1f3116 Binary files /dev/null and b/doctrees/agi.doctree differ diff --git a/doctrees/agitb.doctree b/doctrees/agitb.doctree new file mode 100644 index 0000000..ff94f86 Binary files /dev/null and b/doctrees/agitb.doctree differ diff --git a/doctrees/changes.doctree b/doctrees/changes.doctree new file mode 100644 index 0000000..818f7b9 Binary files /dev/null and b/doctrees/changes.doctree differ diff --git a/doctrees/config.doctree b/doctrees/config.doctree new file mode 100644 index 0000000..54e33a1 Binary files /dev/null and b/doctrees/config.doctree differ diff --git a/doctrees/environment.pickle b/doctrees/environment.pickle new file mode 100644 index 0000000..afcc9ac Binary files /dev/null and b/doctrees/environment.pickle differ diff --git a/doctrees/fastagi.doctree b/doctrees/fastagi.doctree new file mode 100644 index 0000000..7f81a0b Binary files /dev/null and b/doctrees/fastagi.doctree differ diff --git a/doctrees/index.doctree b/doctrees/index.doctree new file mode 100644 index 0000000..5e83d64 Binary files /dev/null and b/doctrees/index.doctree differ diff --git a/doctrees/manager.doctree b/doctrees/manager.doctree new file mode 100644 index 0000000..7e5b4b7 Binary files /dev/null and b/doctrees/manager.doctree differ diff --git a/doctrees/readme.doctree b/doctrees/readme.doctree new file mode 100644 index 0000000..762f397 Binary files /dev/null and b/doctrees/readme.doctree differ