This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Setup — porymap documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: linear-gradient(180deg, #08ACD5 50%, #FF6262 0%);" >
<a href="index.html" class="icon icon-home"> porymap
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">User Manual</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="manual/introduction.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/introduction.html#about-porymap">About Porymap</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/introduction.html#getting-started">Getting Started</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/navigation.html">Navigation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#map-list">Map List</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#main-window">Main Window</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#tileset-editor">Tileset Editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#region-map-editor">Region Map Editor</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-tiles.html">Editing Map Tiles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#visual-options">Visual Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#selecting-metatiles">Selecting Metatiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#pencil-tool">Pencil Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#pointer-tool">Pointer Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#bucket-fill-tool">Bucket Fill Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#map-shift-tool">Map Shift Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#smart-paths">Smart Paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#change-map-border">Change Map Border</a></li>
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#change-map-tilesets">Change Map Tilesets</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-events.html">Editing Map Events</a></li>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="reference/CHANGELOG.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/CHANGELOG.html#unreleased">Unreleased</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#fixed">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/CHANGELOG.html#id1">1.2.1 - 2019-02-16</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#id2">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#id3">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/CHANGELOG.html#id4">1.2.0 - 2019-02-04</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#breaking-changes">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#id5">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#id6">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#id7">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/CHANGELOG.html#id8">1.1.0 - 2018-12-27</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#id9">Breaking Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#id10">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#id11">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/CHANGELOG.html#id12">Fixed</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/CHANGELOG.html#id13">1.0.0 - 2018-10-26</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference/related-projects.html">Related Projects</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">porymap</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Setup</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/README.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<p>This directory holds the sources that build the porymap documentation website. It uses Sphinx to build a static website, and copy the results to the <code class="docutils literal notranslate"><span class="pre">docs/</span></code> directory for GitHub Pages.</p>
<div class="section" id="setup">
<h1>Setup<a class="headerlink" href="#setup" title="Permalink to this headline">¶</a></h1>
<p>Sphinx uses Python, so you can use <code class="docutils literal notranslate"><span class="pre">pip</span></code> to install the dependencies:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">r</span> <span class="n">requirements</span><span class="o">.</span><span class="n">txt</span>
</pre></div>
</div>
</div>
<div class="section" id="build">
<h1>Build<a class="headerlink" href="#build" title="Permalink to this headline">¶</a></h1>
<p>This will build the static site and copy the files to the root-level <code class="docutils literal notranslate"><span class="pre">docs/</span></code> directory. The GitHub Pages site will automatically update when the commit is merged to porymap’
