Commits

Ben Bangert committed 2b4cbce

Remove old layout and use default one for RTD.

  • Participants
  • Parent commits 0e8c3f6
  • Branches default

Comments (0)

Files changed (6)

beaker/docs/_templates/index.html

-{% extends "layout.html" %}
-{% set title = 'Overview' %}
-{% block body %}
-  <p>Beaker is a library for caching and sessions for use with web applications
-      and stand-alone Python scripts and applications. It comes with
-      <a href="http://www.wsgi.org/wsgi/Middleware_and_Utilities">WSGI middleware</a>
-      for easy drop-in use with <a href="http://www.python.org/dev/peps/pep-0333/">WSGI</a>
-      based web applications, and caching decorators for ease of use with
-      any Python based application.</p>
-
-  <ul>
-      <li><b>Lazy-Loading Sessions:</b> No performance hit for having sessions active in
-          a request unless they're actually used</li>
-      <li><b>Performance:</b> Utilizes a multiple-reader / single-writer locking
-          system to prevent the 
-          <a href="http://hype-free.blogspot.com/2008/05/avoiding-dogpile-effect.html">Dog Pile effect</a>
-          when caching.
-          </li>
-      <li><b>Mulitple Back-ends:</b> File-based, DBM files, <a href="http://www.danga.com/memcached/">memcached</a>,
-          memory, and database (via <a href="http://www.sqlalchemy.org/">SQLAlchemy</a>) back-ends available
-          for sessions and caching</li>
-      <li><b>Cookie-based Sessions:</b> SHA-1 signatures with optional AES encryption for client-side
-          cookie-based session storage</li>
-      <li><b>Flexible Caching:</b> Data can be cached per function to different back-ends, with different
-          expirations, and different keys</li>
-      <li><b>Extensible Back-ends:</b> Add more backends using 
-          <a href="http://peak.telecommunity.com/DevCenter/setuptools#extensible-applications-and-frameworks">setuptools entrypoints</a>
-           to support new back-ends.</li>
-  </ul>
-
-  <h2>News</h2>
-  <ul>
-      <li>Beaker 1.6.2 released on 12/13/2011.</li>
-      <li>Beaker 1.6.1 released on 10/20/2011.</li>
-      <li>Beaker 1.6.0 released on 10/16/2011.</li>
-      <li>Beaker 1.5.4 released on 6/16/2010.</li>
-      <li>Beaker 1.5.3 released on 3/2/2010.</li>
-      <li>Beaker 1.5.2 released on 3/1/2010.</li>
-      <li>Beaker 1.5.1 released on 12/17/2009.</li>
-      <li>Beaker 1.5.0 released on 11/23/2009.</li>
-      <li><a href="http://groovie.org/2009/07/24/beaker-1-dot-4-released">Beaker 1.4 Released</a></li>
-      <li><a href="http://groovie.org/2009/04/22/beaker-1-3-is-juicy-caching-goodness">Beaker 1.3 is juicy caching goodness</a></li>
-      <li><a href="http://groovie.org/2007/12/17/beaker-0-9-cookie-stored-sessions-and-crypto">Beaker 0.9, cookie-stored sessions, and crypto</a></li>
-  </ul>
-
-  <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 page</a><br/>
-         <span class="linkdescr">search the documentation</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("py-modindex") }}">Module Index</a><br/>
-         <span class="linkdescr">quick access to all documented modules</span></p>
-    </td></tr>
-  </table>
-
-  <p>Download <a href="http://beaker.groovie.org/Beaker.pdf">Beaker PDF documentation</a>.</p>
-
-  <h2>Source</h2>
-  <p>Beaker's Mercurial repository can be found at
-    <a href="http://bitbucket.org/bbangert/beaker/"><tt>http://bitbucket.org/bbangert/beaker/</tt></a>.</p>
-
-    <p>To check out:</p>
-
-      <pre>hg clone http://www.bitbucket.org/bbangert/beaker</pre>
-
-{% endblock %}

beaker/docs/_templates/indexsidebar.html

-<h3>Download</h3>
-{% if version.endswith('(hg)') %}
-<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/beaker/">Mercurial repo</a> or look for
-  released versions in the <a href="http://pypi.python.org/pypi/Beaker">Python
-    Package Index</a>.</p>
-{% else %}
-<p>Current version: <b>{{ version }}</b></p>
-<p>Get Beaker from the <a href="http://pypi.python.org/pypi/Beaker">Python Package
-Index</a>, or install it with:</p>
-<pre>easy_install -U Beaker</pre>
-{% endif %}
-
-<h3>Bugs? Suggestions?</h3>
-
-<p>Report them at the Bitbucket 
-  <a href="http://www.bitbucket.org/bbangert/beaker/issues/">tracker</a>.</p>

beaker/docs/_templates/layout.html

-{% extends "!layout.html" %}
-
-{% block rootrellink %}
-        <li><a href="{{ pathto('index') }}">Beaker 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;">Beaker</div>
-</div>
-{% endblock %}

beaker/docs/conf.py

 extensions = ['sphinx.ext.autodoc']
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+# templates_path = ['_templates']
 
 # The suffix of source filenames.
 source_suffix = '.rst'
 # 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'
+# html_style = 'default.css'
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
 html_index = 'index.html'
 
 # Custom sidebar templates, maps document names to template names.
-html_sidebars = {'index': 'indexsidebar.html'}
+# 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_additional_pages = {'index': 'index.html'}
 
 html_theme_options = {
     "bgcolor": "#fff",
 # 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://beaker.groovie.org/'
+html_use_opensearch = 'http://beaker.rtfd.org/'
 
 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
 #html_file_suffix = ''

beaker/docs/contents.rst

 Beaker Documentation
 ====================
 
+Beaker is a library for caching and sessions for use with web applications and
+stand-alone Python scripts and applications. It comes with WSGI middleware for
+easy drop-in use with WSGI based web applications, and caching decorators for
+ease of use with any Python based application.
+
+* **Lazy-Loading Sessions**: No performance hit for having sessions active in a request unless they're actually used
+* **Performance**: Utilizes a multiple-reader / single-writer locking system to prevent the Dog Pile effect when caching.
+* **Mulitple Back-ends**: File-based, DBM files, memcached, memory, and database (via SQLAlchemy) back-ends available for sessions and caching
+* **Cookie-based Sessions**: SHA-1 signatures with optional AES encryption for client-side cookie-based session storage
+* **Flexible Caching**: Data can be cached per function to different back-ends, with different expirations, and different keys
+* **Extensible Back-ends**: Add more backends using setuptools entrypoints to support new back-ends.
+
 .. toctree::
    :maxdepth: 2
 

beaker/docs/modules/util.rst

 .. autoclass:: SyncDict
 .. autoclass:: ThreadLocal
 .. autofunction:: verify_directory
-.. autofunction:: b64encode
-.. autofunction:: b64decode
 .. autofunction:: parse_cache_config_options