Anonymous avatar Anonymous committed 91baf71

Initial Sphinx documentation structure.

Comments (0)

Files changed (13)

 WebHelpers.egg-info
 build
 dist
+docs/_build
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html web htmlhelp latex changes linkcheck
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html      to make standalone HTML files"
+	@echo "  web       to make files usable by Sphinx.web"
+	@echo "  htmlhelp  to make HTML files and a HTML help project"
+	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  changes   to make an overview over all changed/added/deprecated items"
+	@echo "  linkcheck to check all external links for integrity"
+
+clean:
+	-rm -rf _build/*
+
+html:
+	mkdir -p _build/html _build/doctrees
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
+	@echo
+	@echo "Build finished. The HTML pages are in _build/html."
+
+web:
+	mkdir -p _build/web _build/doctrees
+	$(SPHINXBUILD) -b web $(ALLSPHINXOPTS) _build/web
+	@echo
+	@echo "Build finished; now you can run"
+	@echo "  python -m sphinx.web _build/web"
+	@echo "to start the server."
+
+htmlhelp:
+	mkdir -p _build/htmlhelp _build/doctrees
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in _build/htmlhelp."
+
+latex:
+	mkdir -p _build/latex _build/doctrees
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in _build/latex."
+	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+	      "run these through (pdf)latex."
+
+changes:
+	mkdir -p _build/changes _build/doctrees
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
+	@echo
+	@echo "The overview file is in _build/changes."
+
+linkcheck:
+	mkdir -p _build/linkcheck _build/doctrees
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in _build/linkcheck/output.txt."

docs/_templates/index.html

+{% extends "layout.html" %}
+{% set title = 'Overview' %}
+{% block body %}
+<h1>WebHelpers</h1>
+
+<img src="_images/webhelpers-logo.png" width="100" height="171"
+style="float:left;margin:1em" />
+
+  
+  <p>WebHelpers is package aimed at providing helper functions for use within
+    web applications.</p>
+
+  <p>These functions are intended to ease web development with template languages by removing common view logic and
+encapsulating it in re-usable modules as well as occasionally providing objects for use within controllers to
+assist with common web development paradigms.</p>
+
+  <p>For support/question/patches, please use the `Pylons mailing list
+  <http://groups.google.com/group/pylons-discuss>`_.</p>
+
+  <p>*Requirements:* Some WebHelper functions require `Routes <http://routes.groovie.org/>`_ to be active in the
+framework for a variety of functions. Currently `Pylons <http://pylons.groovie.org/>`_, `TurboGears <http://trac.turbogears.org/turbogears/wiki/RoutesIntegration>`_,
+and `Aquarium <http://aquarium.sourceforge.net/>`_ support Routes.</p>
+
+  <p>Buzzword Compliance: <em>...</em>, <em>...</em></p>
+
+  <br clear="all" />
+
+<h2>New features</h2>
+
+<div style="font-size:smaller">
+
+<p>Version 1.0b1 (YYYY-MM-DD)</p>
+
+<ul>
+    <li>Completely new manual</li>
+    <li></li>
+</ul>
+
+
+</div>
+
+<p><a href="changes.html">Full changelog</a></p>
+
+
+  <h2>Documentation</h2>
+  <table class="contentstable" align="center" style="margin-left: 30px"><tr>
+    <td width="50%">
+      <p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">Contents</a><br/>
+         <span class="linkdescr">for a complete overview</span></p>
+      <p class="biglink"><a class="biglink" href="{{ pathto("search") }}">Search</a><br/>
+         <span class="linkdescr">search the documentation</span></p>
+      <p class="biglink"><a class="biglink" href="{{ pathto("todo") }}">TODO</a><br/>
+         <span class="linkdescr">future development plans</span></p>
+    </td><td width="50%">
+      <p class="biglink"><a class="biglink" href="{{ pathto("genindex") }}">General Index</a><br/>
+         <span class="linkdescr">all functions, classes, terms</span></p>
+      <p class="biglink"><a class="biglink" href="{{ pathto("modindex") }}">Module Index</a><br/>
+         <span class="linkdescr">quick access to all documented modules</span></p>
+    </td></tr>
+  </table>
+  
+  <p>Download <a href="http://webhelpers.groovie.org/webhelpers.pdf">webhelpers PDF documentation</a>.</p>
+
+  <h2>Developers / Source Code</h2>
+  <p>WebHelpers' Mercurial repository can be found at
+    <a href="http://bitbucket.org/bbangert/webhelpers/"><tt>http://bitbucket.org/bbangert/webhelpers/</tt></a>.</p>
+    
+    <p>To check it out:</p>
+    
+      <pre>hg clone http://www.bitbucket.org/bbangert/webhelpers</pre>
+
+{% endblock %}

docs/_templates/indexsidebar.html

+{% if version.endswith('(hg)') %}
+<h3>Download WebHelpers</h3>
+<p>This documentation is for version <b>{{ version }}</b>, which is
+  not released yet.</p>
+<p>You can use it from the
+  <a href="http://bitbucket.org/bbangert/webhelpers/">Mercurial repo</a> or look for
+  released versions in the <a href="http://pypi.python.org/pypi/WebHelpers">Python
+    Package Index</a>.</p>
+{% else %}
+<h3>Download WebHelpers {{ version }}</h3>
+<p>Get WebHelpers from the <a href="http://pypi.python.org/pypi/WebHelpers">Python Package
+Index</a>, or install it with:</p>
+<pre>easy_install -U WebHelpers</pre>
+{% endif %}
+
+<h3>Bugs? Suggestions?</h3>
+
+<p>Report them at the Bitbucket 
+  <a href="http://www.bitbucket.org/bbangert/webhelpers/issues/">tracker</a>.</p>

docs/_templates/layout.html

+{% extends "!layout.html" %}
+
+{% block rootrellink %}
+        <li><a href="{{ pathto('index') }}">WebHelpers home</a>&nbsp;|&nbsp;</li>
+        <li><a href="{{ pathto('contents') }}">Documentation</a>&raquo;</li>
+{% endblock %}
+
+{% block header %}
+<div style="color: #D1361B; font-size: 70px; font-weight: bold; padding: 10px 0
+0 10px;">WebHelpers</div>
+</div>
+{% endblock %}
+:tocdepth: 2
+
+.. _changes:
+
+.. include:: ../CHANGELOG
+# -*- coding: utf-8 -*-
+#
+# WebHelpers documentation build configuration file
+#
+# 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, os
+
+# If your extensions are in another directory, add it here. If the directory
+# is relative to the documentation root, use os.path.abspath to make it
+# absolute, like shown here.
+#sys.path.append(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']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'contents'
+
+# General substitutions.
+project = 'WebHelpers'
+copyright = '2009, Mike Orr and Ben Bangert'
+
+# The default replacements for |version| and |release|, also used in various
+# other places throughout the built documents.
+#
+# The short X.Y version.
+version = '1.0b1'
+# The full version, including alpha/beta/rc tags.
+release = '1.0b1'
+
+# 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 = []
+
+# 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
+
+html_index = 'index.html'
+
+# Custom sidebar templates, maps document names to template names.
+html_sidebars = {'index': 'indexsidebar.html'}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+html_additional_pages = {'index': 'index.html'}
+
+html_theme_options = {
+    "bgcolor": "#fff",
+    "footertextcolor": "#666",
+    "relbarbgcolor": "#fff",
+    "relbarlinkcolor": "#590915",
+    "relbartextcolor": "#FFAA2D",
+    "sidebarlinkcolor": "#590915",
+    "sidebarbgcolor": "#fff",
+    "sidebartextcolor": "#333",
+    "footerbgcolor": "#fff",
+    "linkcolor": "#590915",
+    "bodyfont": "helvetica, 'bitstream vera sans', sans-serif",
+    "headfont": "georgia, 'bitstream vera sans serif', 'lucida grande', helvetica, verdana, sans-serif",
+    "headbgcolor": "#fff",
+    "headtextcolor": "#12347A",
+    "codebgcolor": "#fff",
+}
+
+# If false, no module index is generated.
+#html_use_modindex = 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, the reST sources are included in the HTML build as _sources/<name>.
+#html_copy_source = 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 = 'http://webhelpers.groovie.org/'
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'WebHelpersdoc'
+
+
+# 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 = [
+  ('contents', 'WebHelpers.tex', u'WebHelpers Documentation',
+   u'Ben Bangert', '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
+
+# Additional stuff for the LaTeX preamble.
+latex_preamble = '''
+\usepackage{palatino}
+\definecolor{TitleColor}{rgb}{0.7,0,0}
+\definecolor{InnerLinkColor}{rgb}{0.7,0,0}
+\definecolor{OuterLinkColor}{rgb}{0.8,0,0}
+\definecolor{VerbatimColor}{rgb}{0.985,0.985,0.985}
+\definecolor{VerbatimBorderColor}{rgb}{0.8,0.8,0.8}
+'''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+latex_use_modindex = False
+
+# Added to handle docs in middleware.py
+autoclass_content = "both"

docs/contents.rst

+Routes Documentation
+====================
+
+.. toctree::
+   :maxdepth: 2
+   
+   manual
+
+.. toctree::
+   :maxdepth: 1
+
+   glossary
+   
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+* :ref:`glossary`
+
+Module Listing
+--------------
+
+.. toctree::
+    :maxdepth: 3
+
+    modules
+    
+    

docs/glossary.rst

+.. _glossary:
+
+Glossary
+========
+
+
+
+.. glossary::
+
+    term
+        Definition
+WebHelpers Manual
+%%%%%%%%%%%%%%%%%
+
+*Updated 2009-09-13 for WebHelpers 1.0b1*
+
+Introduction
+============
+
+.. image:: webhelpers-logo.png
+    :width: 100px
+    :height: 171px
+    :align: left
+
+WebHelpers ...
+:mod:`webhelpers` -- WebHelpers module 
+================================================
+
+.. automodule:: webhelpers
+
+Module Contents
+---------------
+
+ ..
+
+    .. currentmodule:: webhelpers
+
+
+    .. autofunction:: request_config
+
+    .. autoclass:: Mapper
+        :members: connect, create_regs, generate, match, redirect, resource, routematch
+
+    .. autoclass:: URLGenerator
+
+    .. autofunction:: url_for
+
+    .. autofunction:: redirect_to
+
+    .. currentmodule:: routes.mapper
+    .. autofunction:: strip_slashes
+
+    .. currentmodule:: routes.middleware
+
+    .. autoclass:: RoutesMiddleware
+:tocdepth: 2
+
+.. _todo:
+
+.. include:: ../TODO
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.