boxespy/html/apidoc.html

135 lines
6.0 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>Using the Boxes.py API &#8212; boxes.py 0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/nature.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Architecture" href="api_architecture.html" />
<link rel="prev" title="Contributing to Boxes.py" href="CONTRIBUTING.html" />
</head><body>
<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 class="right" >
<a href="api_architecture.html" title="Architecture"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="CONTRIBUTING.html" title="Contributing to Boxes.py"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">boxes.py 0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Using the Boxes.py API</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="using-the-boxes-py-api">
<h1>Using the Boxes.py API<a class="headerlink" href="#using-the-boxes-py-api" title="Permalink to this heading"></a></h1>
<p>If there is no generator fitting your needs you can either adjust an
existing one (may be by copying it to another name first) or writing a
new one from scratch.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="api_architecture.html">Architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_generator.html">Generators</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_arguments.html">Generator Arguments</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_navigation.html">Navigation</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_parts.html">Parts</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_existing_parts.html">Existing Parts</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_edges.html">Edges</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_drawing.html">Drawing commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_burn.html">Burn correction</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_examples.html">Examples</a></li>
</ul>
</div>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/boxes-logo.svg" alt="Logo"/>
</a></p>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="CONTRIBUTING.html"
title="previous chapter">Contributing to Boxes.py</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="api_architecture.html"
title="next chapter">Architecture</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/apidoc.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</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 class="right" >
<a href="api_architecture.html" title="Architecture"
>next</a> |</li>
<li class="right" >
<a href="CONTRIBUTING.html" title="Contributing to Boxes.py"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">boxes.py 0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Using the Boxes.py API</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2016, Florian Festi.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
</div>
</body>
</html>