/usr/share/doc/sphinx-doc/html/develop.html

<!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>Sphinx development &#8212; Sphinx 1.4.9 documentation</title>
    
    <link rel="stylesheet" href="_static/sphinx13.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '1.4.9',
        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="search" type="application/opensearchdescription+xml"
          title="Search within Sphinx 1.4.9 documentation"
          href="_static/opensearch.xml"/>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="top" title="Sphinx 1.4.9 documentation" href="contents.html" />
 
    <style type="text/css">
      table.right { float: right; margin-left: 20px; }
      table.right td { border: 1px solid #ccc; }
      
    </style>
    <script type="text/javascript">
      // intelligent scrolling of the sidebar content
      $(window).scroll(function() {
        var sb = $('.sphinxsidebarwrapper');
        var win = $(window);
        var sbh = sb.height();
        var offset = $('.sphinxsidebar').position()['top'];
        var wintop = win.scrollTop();
        var winbot = wintop + win.innerHeight();
        var curtop = sb.position()['top'];
        var curbot = curtop + sbh;
        // does sidebar fit in window?
        if (sbh < win.innerHeight()) {
          // yes: easy case -- always keep at the top
          sb.css('top', $u.min([$u.max([0, wintop - offset - 10]),
                                $(document).height() - sbh - 200]));
        } else {
          // no: only scroll if top/bottom edge of sidebar is at
          // top/bottom edge of window
          if (curtop > wintop && curbot > winbot) {
            sb.css('top', $u.max([wintop - offset - 10, 0]));
          } else if (curtop < wintop && curbot < winbot) {
            sb.css('top', $u.min([winbot - sbh - offset - 20,
                                  $(document).height() - sbh - 200]));
          }
        }
      });
    </script>

  </head>
  <body role="document">
<div class="pageheader">
  <ul>
    <li><a href="index.html">Home</a></li>
    <li><a href="install.html">Get it</a></li>
    <li><a href="contents.html">Docs</a></li>
    <li><a href="#">Extend/Develop</a></li>
  </ul>
  <div>
    <a href="index.html">
      <img src="_static/sphinxheader.png" alt="SPHINX" />
    </a>
  </div>
</div>

    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li><a href="index.html">Sphinx home</a>&#160;|</li>
        <li><a href="contents.html">Documentation</a> &#187;</li>
 
      </ul>
    </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="contents.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Sphinx development</a></li>
<li><a class="reference internal" href="#extensions">Extensions</a></li>
</ul>

  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/develop.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="sphinx-development">
<h1>Sphinx development<a class="headerlink" href="#sphinx-development" title="Permalink to this headline">¶</a></h1>
<p>Sphinx is a maintained by a group of volunteers.  We value every contribution!</p>
<ul class="simple">
<li>The code can be found in a Git repository, at
<a class="reference external" href="https://github.com/sphinx-doc/sphinx/">https://github.com/sphinx-doc/sphinx/</a>.</li>
<li>Issues and feature requests should be raised in the <a class="reference external" href="https://github.com/sphinx-doc/sphinx/issues">tracker</a>.</li>
<li>The mailing list for development is at <a class="reference external" href="https://groups.google.com/forum/#!forum/sphinx-dev">Google Groups</a>.</li>
<li>There is also the #sphinx-doc IRC channel on <a class="reference external" href="http://freenode.net/">freenode</a>.</li>
</ul>
<p>For more about our development process and methods, see the <a class="reference internal" href="devguide.html"><span class="doc">Sphinx Developer&#8217;s Guide</span></a>.</p>
</div>
<div class="section" id="extensions">
<h1>Extensions<a class="headerlink" href="#extensions" title="Permalink to this headline">¶</a></h1>
<p>To learn how to write your own extension, see <a class="reference internal" href="extdev/index.html#dev-extensions"><span class="std std-ref">Developing extensions for Sphinx</span></a>.</p>
<p>The <a class="reference external" href="https://bitbucket.org/birkenfeld/sphinx-contrib/">sphinx-contrib</a>
repository contains many contributed extensions.  Some of them have their own
releases on PyPI, others you can install from a checkout.</p>
<p>This is the current list of contributed extensions in that repository:</p>
<ul class="simple">
<li>aafig: render embedded ASCII art as nice images using <a class="reference external" href="https://launchpad.net/aafigure">aafigure</a>.</li>
<li>actdiag: embed activity diagrams by using <a class="reference external" href="http://blockdiag.com/en/">actdiag</a></li>
<li>adadomain: an extension for Ada support (Sphinx 1.0 needed)</li>
<li>ansi: parse ANSI color sequences inside documents</li>
<li>autorun: Execute code in a <code class="docutils literal"><span class="pre">runblock</span></code> directive.</li>
<li>blockdiag: embed block diagrams by using <a class="reference external" href="http://blockdiag.com/en/">blockdiag</a></li>
<li>cheeseshop: easily link to PyPI packages</li>
<li>clearquest: create tables from <a class="reference external" href="http://www-03.ibm.com/software/products/en/clearquest">ClearQuest</a> queries.</li>
<li><a class="reference external" href="https://bitbucket.org/klorenz/sphinxcontrib-cmakedomain">cmakedomain</a>: a domain for <a class="reference external" href="https://cmake.org">CMake</a></li>
<li>coffeedomain: a domain for (auto)documenting CoffeeScript source code.</li>
<li>context: a builder for ConTeXt.</li>
<li>doxylink: Link to external Doxygen-generated HTML documentation</li>
<li><a class="reference external" href="https://bitbucket.org/klorenz/sphinxcontrib-domaintools">domaintools</a>: A tool for easy domain creation.</li>
<li>email: obfuscate email addresses</li>
<li>erlangdomain: an extension for Erlang support (Sphinx 1.0 needed)</li>
<li>exceltable: embed Excel spreadsheets into documents using <a class="reference external" href="http://pythonhosted.org/sphinxcontrib-exceltable/">exceltable</a></li>
<li>feed: an extension for creating syndication feeds and time-based overviews
from your site content</li>
<li><a class="reference external" href="https://bitbucket.org/klorenz/sphinxcontrib-findanything">findanything</a>: an extension to add Sublime Text 2-like findanything panels
to your documentation to find pages, sections and index entries while typing</li>
<li>gnuplot: produces images using <a class="reference external" href="http://www.gnuplot.info/">gnuplot</a> language.</li>
<li>googleanalytics: track web visitor statistics by using <a class="reference external" href="http://www.google.com/analytics/">Google Analytics</a></li>
<li>googlechart: embed charts by using <a class="reference external" href="https://developers.google.com/chart/">Google Chart</a></li>
<li>googlemaps: embed maps by using <a class="reference external" href="https://www.google.com/maps">Google Maps</a></li>
<li>httpdomain: a domain for documenting RESTful HTTP APIs.</li>
<li>hyphenator: client-side hyphenation of HTML using <a class="reference external" href="https://github.com/mnater/hyphenator">hyphenator</a></li>
<li><a class="reference external" href="http://sphinxcontrib-inlinesyntaxhighlight.readthedocs.org">inlinesyntaxhighlight</a>: inline syntax highlighting</li>
<li>lassodomain: a domain for documenting <a class="reference external" href="http://www.lassosoft.com/">Lasso</a> source code</li>
<li>libreoffice: an extension to include any drawing supported by LibreOffice (e.g. odg, vsd...).</li>
<li>lilypond: an extension inserting music scripts from <a class="reference external" href="http://lilypond.org/">Lilypond</a> in PNG format.</li>
<li><a class="reference external" href="https://bitbucket.org/klorenz/sphinxcontrib-makedomain">makedomain</a>: a domain for <a class="reference external" href="http://www.gnu.org/software/make/">GNU Make</a></li>
<li>matlabdomain: document <a class="reference external" href="http://www.mathworks.com/products/matlab/">MATLAB</a> code.</li>
<li>mockautodoc: mock imports.</li>
<li>mscgen: embed mscgen-formatted MSC (Message Sequence Chart)s.</li>
<li>napoleon: supports <a class="reference external" href="http://google-styleguide.googlecode.com/svn/trunk/pyguide.html">Google style</a> and <a class="reference external" href="https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt">NumPy style</a> docstrings.</li>
<li>nicoviceo: embed videos from nicovideo</li>
<li>nwdiag: embed network diagrams by using <a class="reference external" href="http://blockdiag.com/en/">nwdiag</a></li>
<li>omegat: support tools to collaborate with <a class="reference external" href="http://www.omegat.org/">OmegaT</a> (Sphinx 1.1 needed)</li>
<li>osaka: convert standard Japanese doc to Osaka dialect (it is joke extension)</li>
<li>paverutils: an alternate integration of Sphinx with <a class="reference external" href="http://paver.github.io/paver/">Paver</a>.</li>
<li>phpdomain: an extension for PHP support</li>
<li>plantuml: embed UML diagram by using <a class="reference external" href="http://plantuml.com/">PlantUML</a></li>
<li>py_directive: Execute python code in a <code class="docutils literal"><span class="pre">py</span></code> directive and return a math
node.</li>
<li>rawfiles: copy raw files, like a CNAME.</li>
<li>requirements: declare requirements wherever you need (e.g. in test
docstrings), mark statuses and collect them in a single list</li>
<li>restbuilder: a builder for reST (reStructuredText) files.</li>
<li>rubydomain: an extension for Ruby support (Sphinx 1.0 needed)</li>
<li>sadisplay: display SqlAlchemy model <a class="reference external" href="https://bitbucket.org/estin/sadisplay/wiki/Home">sadisplay</a></li>
<li>sdedit: an extension inserting sequence diagram by using Quick Sequence
Diagram Editor (<a class="reference external" href="http://sdedit.sourceforge.net/">sdedit</a>)</li>
<li>seqdiag: embed sequence diagrams by using <a class="reference external" href="http://blockdiag.com/en/">seqdiag</a></li>
<li>slide: embed presentation slides on <a class="reference external" href="http://www.slideshare.net/">slideshare</a> and other sites.</li>
<li><a class="reference external" href="https://bitbucket.org/klorenz/sphinxcontrib-swf">swf</a>: embed flash files</li>
<li>sword: an extension inserting Bible verses from <a class="reference external" href="http://www.crosswire.org/sword/">Sword</a>.</li>
<li>tikz: draw pictures with the <a class="reference external" href="https://sourceforge.net/projects/pgf/">TikZ/PGF LaTeX package</a>.</li>
<li>traclinks: create <a class="reference external" href="http://trac.edgewall.org/wiki/TracLinks">TracLinks</a> to a <a class="reference external" href="http://trac.edgewall.org">Trac</a> instance from within Sphinx</li>
<li>whooshindex: whoosh indexer extension</li>
<li>youtube: embed videos from <a class="reference external" href="http://www.youtube.com/">YouTube</a></li>
<li>zopeext: provide an <code class="docutils literal"><span class="pre">autointerface</span></code> directive for using <a class="reference external" href="http://docs.zope.org/zope.interface/README.html">Zope interfaces</a>.</li>
</ul>
<p>See the <a class="reference internal" href="extdev/tutorial.html#exttut"><span class="std std-ref">extension tutorial</span></a> on getting started with writing your
own extensions.</p>
</div>


          </div>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li><a href="index.html">Sphinx home</a>&#160;|</li>
        <li><a href="contents.html">Documentation</a> &#187;</li>
 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2007-2016, Georg Brandl and the Sphinx team.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.9.
    </div>
  </body>
</html>
sphinx-doc 1.4.9-2 / usr / share / doc / sphinx-doc / html / develop.html
