openstack/deb-python-taskflow
Code Issues Proposed changes

Merge "Rework sphinx documentation"

Browse Source
This commit is contained in:
Jenkins
2014-02-19 18:20:24 +00:00
committed by Gerrit Code Review
parent b2a796a6e9 b5347054aa
commit ba951fbf48
25 changed files with 202 additions and 981 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -41,3 +41,14 @@ as input the `tox-tmpl.ini` file to generate the final `tox.ini` file.
*For example:* *For example:*
$ toxgen.py -i tox-tmpl.ini -o tox.ini $ toxgen.py -i tox-tmpl.ini -o tox.ini
Documentation
-------------
http://wiki.openstack.org/wiki/TaskFlow
We also have sphinx documentation in `docs/source`. To build it,
run:
$ python ./setup.py build_sphinx

177
doc/Makefile
View File

@@ -1,177 +0,0 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# 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) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
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 " 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)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
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."
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/taskflow.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/taskflow.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/taskflow"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/taskflow"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
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)."
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."
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."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
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)."
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."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
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."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

331
doc/conf.py
View File

@@ -1,331 +0,0 @@
# -*- coding: utf-8 -*-
#
# taskflow documentation build configuration file, created by
# sphinx-quickstart on Mon Nov 25 17:55:12 2013.
#
# 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.viewcode',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
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'taskflow'
copyright = u'2013, Alex'
# 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 = ''
# The full version, including alpha/beta/rc tags.
release = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#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 = ['_build']
# 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
# -- 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 = 'default'
# 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
# "<project> v<release> 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 (within the static path) to use as 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 <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
# Output file base name for HTML help builder.
htmlhelp_basename = 'taskflowdoc'
# -- 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': '',
}
# 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 = [
('index', 'taskflow.tex', u'taskflow Documentation',
u'Alex', '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 = [
('index', 'taskflow', u'taskflow Documentation',
[u'Alex'], 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 = [
('index', 'taskflow', u'taskflow Documentation',
u'Alex', 'taskflow', '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
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = u'taskflow'
epub_author = u'Alex'
epub_publisher = u'Alex'
epub_copyright = u'2013, Alex'
# The basename for the epub file. It defaults to the project name.
#epub_basename = u'taskflow'
# The HTML theme for the epub output. Since the default themes are not optimized
# for small screen space, using the same theme for HTML and epub output is
# usually not wise. This defaults to 'epub', a theme designed to save visual
# space.
#epub_theme = 'epub'
# The language of the text. It defaults to the language option
# or en if the language is not set.
#epub_language = ''
# The scheme of the identifier. Typical schemes are ISBN or URL.
#epub_scheme = ''
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#epub_identifier = ''
# A unique identification for the text.
#epub_uid = ''
# A tuple containing the cover image and cover page html template filenames.
#epub_cover = ()
# A sequence of (type, uri, title) tuples for the guide element of content.opf.
#epub_guide = ()
# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_pre_files = []
# HTML files shat should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_post_files = []
# A list of files that should not be packed into the epub file.
#epub_exclude_files = []
# The depth of the table of contents in toc.ncx.
#epub_tocdepth = 3
# Allow duplicate toc entries.
#epub_tocdup = True
# Choose between 'default' and 'includehidden'.
#epub_tocscope = 'default'
# Fix unsupported image types using the PIL.
#epub_fix_images = False
# Scale large images.
#epub_max_image_width = 0
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#epub_show_urls = 'inline'
# If false, no index is generated.
#epub_use_index = True

20
doc/index.rst
View File

@@ -1,20 +0,0 @@
Taskflow
========
Taskflow is a Python library for OpenStack that helps make task execution easy, consistent, and reliable.
Contents
========
.. toctree::
:maxdepth: 2
taskflow
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

7
doc/source/atoms.rst Normal file
View File

@@ -0,0 +1,7 @@
-----
Tasks
-----
.. automodule:: taskflow.atom
.. automodule:: taskflow.task

83
doc/source/conf.py Normal file
View File

@@ -0,0 +1,83 @@
# -*- coding: utf-8 -*-
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
# -- General configuration ----------------------------------------------------
# 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.viewcode',
'oslosphinx'
]
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
# execute "export SPHINX_DEBUG=1" in your terminal to disable
# Add any paths that contain templates here, relative to this directory.
# templates_path = []
# The suffix of source filenames.
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# General information about the project.
project = u'TaskFlow'
copyright = u'2013-2014, OpenStack Foundation'
# 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
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = ["."]
# html_theme = '_theme'
html_static_path = ['static']
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1"
html_last_updated_fmt = os.popen(git_cmd).read()
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
('index',
'%s.tex' % project,
'%s Documentation' % project,
'OpenStack Foundation', 'manual'),
]
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None}
# -- Options for autoddoc ----------------------------------------------------
# Keep source order
autodoc_member_order = 'bysource'
# Always include members
autodoc_default_flags = ['members', 'show-inheritance']

7
doc/source/engines.rst Normal file
View File

@@ -0,0 +1,7 @@
-------
Engines
-------
.. automodule:: taskflow.engines.base
.. automodule:: taskflow.engines.helpers

5
doc/source/exceptions.rst Normal file
View File

@@ -0,0 +1,5 @@
----------
Exceptions
----------
.. automodule:: taskflow.exceptions

28
doc/source/index.rst Normal file
View File

@@ -0,0 +1,28 @@
TaskFlow
========
TaskFlow is a Python library for OpenStack that helps make task execution easy, consistent, and reliable.
TaskFlow documentation is hosted on wiki: https://wiki.openstack.org/wiki/TaskFlow
Contents
========
.. toctree::
:maxdepth: 1
atoms
patterns
engines
storage
persistence
exceptions
utils
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

23
doc/source/patterns.rst Normal file
View File

@@ -0,0 +1,23 @@
--------
Patterns
--------
.. automodule:: taskflow.flow
Linear flow
~~~~~~~~~~~
.. automodule:: taskflow.patterns.linear_flow
Unordered flow
~~~~~~~~~~~~~~
.. automodule:: taskflow.patterns.unordered_flow
Graph flow
~~~~~~~~~~
.. automodule:: taskflow.patterns.graph_flow

17
doc/source/persistence.rst Normal file
View File

@@ -0,0 +1,17 @@
-----------
Persistence
-----------
Persistence objects
~~~~~~~~~~~~~~~~~~~
.. automodule:: taskflow.persistence.logbook
Persistence backends
~~~~~~~~~~~~~~~~~~~~
.. automodule:: taskflow.persistence.backends
:undoc-members:
.. automodule:: taskflow.persistence.backends.base

5
doc/source/storage.rst Normal file
View File

@@ -0,0 +1,5 @@
-------
Storage
-------
.. automodule:: taskflow.storage

5
doc/source/utils.rst Normal file
View File

@@ -0,0 +1,5 @@
-----
Utils
-----
.. autoclass:: taskflow.utils.misc.Failure

46
doc/taskflow.engines.action_engine.rst
View File

@@ -1,46 +0,0 @@
taskflow.engines.action_engine package
======================================
Submodules
----------
taskflow.engines.action_engine.base_action module
-------------------------------------------------
.. automodule:: taskflow.engines.action_engine.base_action
:members:
:undoc-members:
:show-inheritance:
taskflow.engines.action_engine.engine module
--------------------------------------------
.. automodule:: taskflow.engines.action_engine.engine
:members:
:undoc-members:
:show-inheritance:
taskflow.engines.action_engine.graph_action module
--------------------------------------------------
.. automodule:: taskflow.engines.action_engine.graph_action
:members:
:undoc-members:
:show-inheritance:
taskflow.engines.action_engine.task_action module
-------------------------------------------------
.. automodule:: taskflow.engines.action_engine.task_action
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: taskflow.engines.action_engine
:members:
:undoc-members:
:show-inheritance:

37
doc/taskflow.engines.rst
View File

@@ -1,37 +0,0 @@
taskflow.engines package
========================
Subpackages
-----------
.. toctree::
taskflow.engines.action_engine
Submodules
----------
taskflow.engines.base module
----------------------------
.. automodule:: taskflow.engines.base
:members:
:undoc-members:
:show-inheritance:
taskflow.engines.helpers module
-------------------------------
.. automodule:: taskflow.engines.helpers
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: taskflow.engines
:members:
:undoc-members:
:show-inheritance:

30
doc/taskflow.jobs.rst
View File

@@ -1,30 +0,0 @@
taskflow.jobs package
=====================
Submodules
----------
taskflow.jobs.job module
------------------------
.. automodule:: taskflow.jobs.job
:members:
:undoc-members:
:show-inheritance:
taskflow.jobs.jobboard module
-----------------------------
.. automodule:: taskflow.jobs.jobboard
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: taskflow.jobs
:members:
:undoc-members:
:show-inheritance:

38
doc/taskflow.listeners.rst
View File

@@ -1,38 +0,0 @@
taskflow.listeners package
==========================
Submodules
----------
taskflow.listeners.base module
------------------------------
.. automodule:: taskflow.listeners.base
:members:
:undoc-members:
:show-inheritance:
taskflow.listeners.logging module
---------------------------------
.. automodule:: taskflow.listeners.logging
:members:
:undoc-members:
:show-inheritance:
taskflow.listeners.printing module
----------------------------------
.. automodule:: taskflow.listeners.printing
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: taskflow.listeners
:members:
:undoc-members:
:show-inheritance:

38
doc/taskflow.patterns.rst
View File

@@ -1,38 +0,0 @@
taskflow.patterns package
=========================
Submodules
----------
taskflow.patterns.graph_flow module
-----------------------------------
.. automodule:: taskflow.patterns.graph_flow
:members:
:undoc-members:
:show-inheritance:
taskflow.patterns.linear_flow module
------------------------------------
.. automodule:: taskflow.patterns.linear_flow
:members:
:undoc-members:
:show-inheritance:
taskflow.patterns.unordered_flow module
---------------------------------------
.. automodule:: taskflow.patterns.unordered_flow
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: taskflow.patterns
:members:
:undoc-members:
:show-inheritance:

53
doc/taskflow.persistence.backends.rst
View File

@@ -1,53 +0,0 @@
taskflow.persistence.backends package
=====================================
Subpackages
-----------
.. toctree::
taskflow.persistence.backends.sqlalchemy
Submodules
----------
taskflow.persistence.backends.base module
-----------------------------------------
.. automodule:: taskflow.persistence.backends.base
:members:
:undoc-members:
:show-inheritance:
taskflow.persistence.backends.impl_dir module
---------------------------------------------
.. automodule:: taskflow.persistence.backends.impl_dir
:members:
:undoc-members:
:show-inheritance:
taskflow.persistence.backends.impl_memory module
------------------------------------------------
.. automodule:: taskflow.persistence.backends.impl_memory
:members:
:undoc-members:
:show-inheritance:
taskflow.persistence.backends.impl_sqlalchemy module
----------------------------------------------------
.. automodule:: taskflow.persistence.backends.impl_sqlalchemy
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: taskflow.persistence.backends
:members:
:undoc-members:
:show-inheritance:

30
doc/taskflow.persistence.backends.sqlalchemy.rst
View File

@@ -1,30 +0,0 @@
taskflow.persistence.backends.sqlalchemy package
================================================
Submodules
----------
taskflow.persistence.backends.sqlalchemy.migration module
---------------------------------------------------------
.. automodule:: taskflow.persistence.backends.sqlalchemy.migration
:members:
:undoc-members:
:show-inheritance:
taskflow.persistence.backends.sqlalchemy.models module
------------------------------------------------------
.. automodule:: taskflow.persistence.backends.sqlalchemy.models
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: taskflow.persistence.backends.sqlalchemy
:members:
:undoc-members:
:show-inheritance:

29
doc/taskflow.persistence.rst
View File

@@ -1,29 +0,0 @@
taskflow.persistence package
============================
Subpackages
-----------
.. toctree::
taskflow.persistence.backends
Submodules
----------
taskflow.persistence.logbook module
-----------------------------------
.. automodule:: taskflow.persistence.logbook
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: taskflow.persistence
:members:
:undoc-members:
:show-inheritance:

74
doc/taskflow.rst
View File

@@ -1,74 +0,0 @@
taskflow package
================
Subpackages
-----------
.. toctree::
taskflow.engines
taskflow.jobs
taskflow.listeners
taskflow.patterns
taskflow.persistence
taskflow.utils
Submodules
----------
taskflow.exceptions module
--------------------------
.. automodule:: taskflow.exceptions
:members:
:undoc-members:
:show-inheritance:
taskflow.flow module
--------------------
.. automodule:: taskflow.flow
:members:
:undoc-members:
:show-inheritance:
taskflow.states module
----------------------
.. automodule:: taskflow.states
:members:
:undoc-members:
:show-inheritance:
taskflow.storage module
-----------------------
.. automodule:: taskflow.storage
:members:
:undoc-members:
:show-inheritance:
taskflow.task module
--------------------
.. automodule:: taskflow.task
:members:
:undoc-members:
:show-inheritance:
taskflow.version module
-----------------------
.. automodule:: taskflow.version
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: taskflow
:members:
:undoc-members:
:show-inheritance:

78
doc/taskflow.utils.rst
View File

@@ -1,78 +0,0 @@
taskflow.utils package
======================
Submodules
----------
taskflow.utils.eventlet_utils module
------------------------------------
.. automodule:: taskflow.utils.eventlet_utils
:members:
:undoc-members:
:show-inheritance:
taskflow.utils.flow_utils module
--------------------------------
.. automodule:: taskflow.utils.flow_utils
:members:
:undoc-members:
:show-inheritance:
taskflow.utils.graph_utils module
---------------------------------
.. automodule:: taskflow.utils.graph_utils
:members:
:undoc-members:
:show-inheritance:
taskflow.utils.lock_utils module
--------------------------------
.. automodule:: taskflow.utils.lock_utils
:members:
:undoc-members:
:show-inheritance:
taskflow.utils.misc module
--------------------------
.. automodule:: taskflow.utils.misc
:members:
:undoc-members:
:show-inheritance:
taskflow.utils.persistence_utils module
---------------------------------------
.. automodule:: taskflow.utils.persistence_utils
:members:
:undoc-members:
:show-inheritance:
taskflow.utils.reflection module
--------------------------------
.. automodule:: taskflow.utils.reflection
:members:
:undoc-members:
:show-inheritance:
taskflow.utils.threading_utils module
-------------------------------------
.. automodule:: taskflow.utils.threading_utils
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: taskflow.utils
:members:
:undoc-members:
:show-inheritance:

8
setup.cfg
View File

@@ -53,3 +53,11 @@ verbosity = 2
[wheel] [wheel]
universal = 1 universal = 1
[build_sphinx]
source-dir = doc/source
build-dir = doc/build
all_files = 1
[upload_sphinx]
upload-dir = doc/build/html

3
test-requirements.txt
View File

@@ -6,3 +6,6 @@ python-subunit>=0.0.18
testrepository>=0.0.17 testrepository>=0.0.17
testtools>=0.9.34 testtools>=0.9.34
zake>=0.0.13 zake>=0.0.13
# docs build jobs
sphinx
oslosphinx