From 5041a23297c20a522c2ed7aa8f2e26514f3d49f3 Mon Sep 17 00:00:00 2001 From: ianb Date: Thu, 29 May 2008 01:25:49 +0000 Subject: sphinx-ify --- docs/conf.py | 132 +++++++++++++++++++++++++++++++++++++++++++++++ docs/index.txt | 6 +++ docs/modules/tempita.txt | 24 +++++++++ regen-docs | 9 ++++ 4 files changed, 171 insertions(+) create mode 100644 docs/conf.py create mode 100644 docs/modules/tempita.txt create mode 100755 regen-docs diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..9101d5e --- /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 = 'Tempita' +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 = '0.2.1' +# The full version, including alpha/beta/rc tags. +release = '0.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/. +#html_copy_source = True + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Tempitadoc' + + +# 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 cf0d91e..7ef2598 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -1,6 +1,12 @@ Tempita +++++++ +.. toctree:: + :maxdepth: 1 + + license + modules/tempita + .. contents:: :author: Ian Bicking diff --git a/docs/modules/tempita.txt b/docs/modules/tempita.txt new file mode 100644 index 0000000..4da916c --- /dev/null +++ b/docs/modules/tempita.txt @@ -0,0 +1,24 @@ +:mod:`tempita` -- A small templating language +============================================= + +.. automodule:: tempita + +Module Contents +--------------- + +.. autoexception:: TemplateError +.. autoclass:: Template +.. autofunction:: sub +.. autoclass:: bunch + +HTML Templates +~~~~~~~~~~~~~~ + +.. autoclass:: HTMLTemplate +.. autofunction sub_html + +.. autofunction:: html +.. autofunction:: html_quote +.. autofunction:: url +.. autofunction:: attr + diff --git a/regen-docs b/regen-docs new file mode 100755 index 0000000..a99e66c --- /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/tempita/ +fi -- cgit v1.2.1