_themes
Directory actions
More options
Directory actions
More options
_themes
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
parent directory.. | ||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>krTheme Sphinx Style — osxpython v0.0.1 documentation</title> <link rel="stylesheet" href="../_static/flasky.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', VERSION: '0.0.1', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <link rel="top" title="osxpython v0.0.1 documentation" href="../index.html" /> <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" /> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li><a href="../index.html">osxpython v0.0.1 documentation</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="krtheme-sphinx-style"> <h1>krTheme Sphinx Style<a class="headerlink" href="#krtheme-sphinx-style" title="Permalink to this headline">¶</a></h1> <p>This repository contains sphinx styles Kenneth Reitz uses in most of his projects. It is a drivative of Mitsuhiko’s themes for Flask and Flask related projects. To use this style in your Sphinx documentation, follow this guide:</p> <ol class="arabic"> <li><p class="first">put this folder as _themes into your docs folder. Alternatively you can also use git submodules to check out the contents there.</p> </li> <li><p class="first">add this to your conf.py:</p> <div class="highlight-python"><div class="highlight"><pre><span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="s">'_themes'</span><span class="p">))</span> <span class="n">html_theme_path</span> <span class="o">=</span> <span class="p">[</span><span class="s">'_themes'</span><span class="p">]</span> <span class="n">html_theme</span> <span class="o">=</span> <span class="s">'flask'</span> </pre></div> </div> </li> </ol> <p>The following themes exist:</p> <dl class="docutils"> <dt><strong>kr</strong></dt> <dd>the standard flask documentation theme for large projects</dd> <dt><strong>kr_small</strong></dt> <dd>small one-page theme. Intended to be used by very small addon libraries.</dd> </dl> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"><h3>Related Topics</h3> <ul> <li><a href="../index.html">Documentation overview</a><ul> </ul></li> </ul> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../_sources/_themes/README.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../search.html" method="get"> <input type="text" name="q" size="18" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="footer"> © Copyright 2010, Kenneth Reitz. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>. </div> </body> </html>