diff options
author | ianb <ianb@localhost> | 2008-05-29 00:13:58 +0000 |
---|---|---|
committer | ianb <ianb@localhost> | 2008-05-29 00:13:58 +0000 |
commit | 5887c196ccb777ba8ac4c5301631e4d2443a3268 (patch) | |
tree | 48f09623158d21ea0dd8cc0442e3894da88be653 | |
parent | 439617a19bd8ede40576e03df5eba2714e127cfe (diff) | |
download | pastedeploy-git-5887c196ccb777ba8ac4c5301631e4d2443a3268.tar.gz |
sphinx-ify
-rw-r--r-- | docs/conf.py | 132 | ||||
-rw-r--r-- | docs/index.txt | 8 | ||||
-rw-r--r-- | docs/modules/config.txt | 13 | ||||
-rw-r--r-- | docs/modules/converters.txt | 11 | ||||
-rw-r--r-- | docs/modules/loadwsgi.txt | 13 | ||||
-rwxr-xr-x | regen-docs | 9 |
6 files changed, 186 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..a2c1de4 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,132 @@ +# -*- coding: utf-8 -*- +# +# Paste documentation build configuration file, created by +# sphinx-quickstart on Tue Apr 22 22:08:49 2008. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# The contents of this file are pickled, so don't put values in the namespace +# that aren't pickleable (module imports are okay, they're removed automatically). +# +# All configuration values have a default value; values that are commented out +# serve to show the default value. + +import sys + +# If your extensions are in another directory, add it here. +#sys.path.append('some/directory') + +# 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'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.txt' + +# The master toctree document. +master_doc = 'index' + +# General substitutions. +project = 'Paste Deploy' +copyright = '2008, Ian Bicking' + +# The default replacements for |version| and |release|, also used in various +# other places throughout the built documents. +# +# The short X.Y version. +version = '1.3' +# The full version, including alpha/beta/rc tags. +release = '1.3.2' + +# 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 documents that shouldn't be included in the build. +#unused_docs = ['include/contact.txt', 'include/reference_header.txt'] + +# 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' + + +# Options for HTML output +# ----------------------- + +# The style sheet to use for HTML and HTML Help pages. A file of that name +# must exist either in Sphinx' static/ path, or in one of the custom paths +# given in html_static_path. +html_style = 'default.css' + +# 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'] + +# 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 + +# Content template for the index page. +#html_index = '' + +# 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_use_modindex = True + +# If true, the reST sources are included in the HTML build as _sources/<name>. +#html_copy_source = True + +# Output file base name for HTML help builder. +htmlhelp_basename = 'PasteDeploydoc' + + +# Options for LaTeX output +# ------------------------ + +# The paper size ('letter' or 'a4'). +#latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +#latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, document class [howto/manual]). +#latex_documents = [] + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_use_modindex = True diff --git a/docs/index.txt b/docs/index.txt index 8ffb455..0e05b24 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -5,6 +5,14 @@ Paste Deployment :revision: $Rev$ :date: $LastChangedDate$ +Contents: + +.. toctree:: + :maxdepth: 1 + + news + license + .. contents:: .. comment: diff --git a/docs/modules/config.txt b/docs/modules/config.txt new file mode 100644 index 0000000..9d8f894 --- /dev/null +++ b/docs/modules/config.txt @@ -0,0 +1,13 @@ +:mod:`paste.deploy.config` -- Configuration and Environment middleware +====================================================================== + +.. automodule:: paste.deploy.config + +Module Contents +--------------- + +.. autoclass:: DispatchingConfig +.. autoclass:: ConfigMiddleware +.. autoclass:: PrefixMiddleware + +.. comment: FIXME: do something about CONFIG (manual docs?) diff --git a/docs/modules/converters.txt b/docs/modules/converters.txt new file mode 100644 index 0000000..4948104 --- /dev/null +++ b/docs/modules/converters.txt @@ -0,0 +1,11 @@ +:mod:`paste.deploy.converters` -- Conversion helpers for String Configuration +============================================================================= + +.. automodule:: paste.deploy.converters + +Module Contents +--------------- + +.. autofunction:: asbool +.. autofunction:: asint +.. autofunction:: aslist diff --git a/docs/modules/loadwsgi.txt b/docs/modules/loadwsgi.txt new file mode 100644 index 0000000..fc3dc4c --- /dev/null +++ b/docs/modules/loadwsgi.txt @@ -0,0 +1,13 @@ +:mod:`paste.deploy.loadwsgi` -- Load WSGI applications from config files +======================================================================== + +.. automodule:: paste.deploy.loadwsgi + +Module Contents +--------------- + +.. autofunction:: loadapp +.. autofunction:: loadserver +.. autofunction:: loadfilter +.. autofunction;: appconfig + diff --git a/regen-docs b/regen-docs new file mode 100755 index 0000000..f8dad75 --- /dev/null +++ b/regen-docs @@ -0,0 +1,9 @@ +#!/bin/sh + +mkdir -p docs/_static docs/_build +sphinx-build -E -b html docs/ docs/_build || exit 1 +if [ "$1" = "publish" ] ; then + cd docs/ + echo "Uploading files..." + scp -r _build/* ianb@webwareforpython.org:/home/paste/htdocs/deploy/ +fi |