mirror of
https://github.com/wassname/geopandas.git
synced 2026-09-11 12:10:59 +08:00
476 lines
26 KiB
HTML
476 lines
26 KiB
HTML
|
|
|
|
<!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>Contributing to GeoPandas — GeoPandas 0.2-py3.5.egg documentation</title>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700&subset=latin,cyrillic' rel='stylesheet' type='text/css'>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="author" title="About these documents"
|
|
href="about.html"/>
|
|
<link rel="top" title="GeoPandas 0.2-py3.5.egg documentation" href="index.html"/>
|
|
<link rel="next" title="About" href="about.html"/>
|
|
<link rel="prev" title="Reference" href="reference.html"/>
|
|
|
|
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-nav-search">
|
|
|
|
<a href="index.html" class="fa fa-home"> GeoPandas</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">
|
|
|
|
|
|
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="install.html#installing-geopandas">Installing GeoPandas</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="install.html#dependencies">Dependencies</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="data_structures.html">Data Structures</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="data_structures.html#geoseries">GeoSeries</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="data_structures.html#geodataframe">GeoDataFrame</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="io.html">Reading and Writing Files</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="io.html#reading-spatial-data">Reading Spatial Data</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="io.html#writing-spatial-data">Writing Spatial Data</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="mapping.html">Making Maps</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="mapping.html#chloropleth-maps">Chloropleth Maps</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="mapping.html#maps-with-layers">Maps with Layers</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="mapping.html#other-resources">Other Resources</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projections.html">Managing Projections</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="projections.html#coordinate-reference-systems">Coordinate Reference Systems</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="projections.html#setting-a-projection">Setting a Projection</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="projections.html#re-projecting">Re-Projecting</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="geometric_manipulations.html">Geometric Manipulations</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="geometric_manipulations.html#constructive-methods">Constructive Methods</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="geometric_manipulations.html#affine-transformations">Affine transformations</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="set_operations.html">Set Operations with overlay</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="set_operations.html#the-different-overlay-operations">The different Overlay operations</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="set_operations.html#overlay-countries-example">Overlay Countries Example</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="set_operations.html#more-examples">More Examples</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="aggregation_with_dissolve.html">Aggregation with dissolve</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="aggregation_with_dissolve.html#dissolve-example"><code class="docutils literal"><span class="pre">dissolve</span></code> Example</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="mergingdata.html">Merging Data</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="mergingdata.html#attribute-joins">Attribute Joins</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="mergingdata.html#spatial-joins">Spatial Joins</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="geocoding.html">Geocoding</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference to All Attributes and Methods</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="reference.html#geodataframe">GeoDataFrame</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="">Contributing to GeoPandas</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="#overview">Overview</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#forking-the-geopandas-repository-using-git">1) Forking the <em>geopandas</em> repository using Git</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#creating-a-development-environment">2) Creating a development environment</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#installing-dependencies">3) Installing Dependencies</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#making-a-development-build">4) Making a development build</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#making-changes-and-writing-tests">5) Making changes and writing tests</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#updating-the-documentation">6) Updating the Documentation</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#submitting-a-pull-request">7) Submitting a Pull Request</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="about.html#known-issues">Known issues</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="index.html">GeoPandas</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>Contributing to GeoPandas</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
<a href="_sources/contributing.txt" rel="nofollow"> View page source</a>
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document">
|
|
|
|
<div class="section" id="contributing-to-geopandas">
|
|
<h1>Contributing to GeoPandas<a class="headerlink" href="#contributing-to-geopandas" title="Permalink to this headline">¶</a></h1>
|
|
<p>(Contribution guidelines largely copied from <a class="reference external" href="http://pandas.pydata.org/pandas-docs/stable/contributing.html">pandas</a>)</p>
|
|
<div class="section" id="overview">
|
|
<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
|
|
<p>Contributions to GeoPandas are very welcome. They are likely to
|
|
be accepted more quickly if they follow these guidelines.</p>
|
|
<p>At this stage of GeoPandas development, the priorities are to define a
|
|
simple, usable, and stable API and to have clean, maintainable,
|
|
readable code. Performance matters, but not at the expense of those
|
|
goals.</p>
|
|
<p>In general, GeoPandas follows the conventions of the pandas project
|
|
where applicable.</p>
|
|
<p>In particular, when submitting a pull request:</p>
|
|
<ul class="simple">
|
|
<li>All existing tests should pass. Please make sure that the test
|
|
suite passes, both locally and on
|
|
<a class="reference external" href="https://travis-ci.org/geopandas/geopandas">Travis CI</a>. Status on
|
|
Travis will be visible on a pull request. If you want to enable
|
|
Travis CI on your own fork, please read the pandas guidelines link
|
|
above or the
|
|
<a class="reference external" href="http://about.travis-ci.org/docs/user/getting-started/">getting started docs</a>.</li>
|
|
<li>New functionality should include tests. Please write reasonable
|
|
tests for your code and make sure that they pass on your pull request.</li>
|
|
<li>Classes, methods, functions, etc. should have docstrings. The first
|
|
line of a docstring should be a standalone summary. Parameters and
|
|
return values should be ducumented explicitly.</li>
|
|
<li>GeoPandas supports python 2 (2.6+) and python 3 (3.2+) with a single
|
|
code base. Use modern python idioms when possible that are
|
|
compatibile with both major versions, and use the
|
|
<a class="reference external" href="https://pythonhosted.org/six">six</a> library where helpful to smooth
|
|
over the differences. Use <code class="docutils literal"><span class="pre">from</span> <span class="pre">__future__</span> <span class="pre">import</span></code> statements where
|
|
appropriate. Test code locally in both python 2 and python 3 when
|
|
possible (all supported versions will be automatically tested on
|
|
Travis CI).</li>
|
|
<li>Follow PEP 8 when possible.</li>
|
|
<li>Imports should be grouped with standard library imports first,
|
|
3rd-party libraries next, and geopandas imports third. Within each
|
|
grouping, imports should be alphabetized. Always use absolute
|
|
imports when possible, and explicit relative imports for local
|
|
imports when necessary in tests.</li>
|
|
</ul>
|
|
<div class="section" id="seven-steps-for-contributing">
|
|
<h3>Seven Steps for Contributing<a class="headerlink" href="#seven-steps-for-contributing" title="Permalink to this headline">¶</a></h3>
|
|
<p>There are seven basic steps to contributing to <em>geopandas</em>:</p>
|
|
<ol class="arabic simple">
|
|
<li>Fork the <em>geopandas</em> git repository</li>
|
|
<li>Create a development environment</li>
|
|
<li>Install <em>geopandas</em> dependencies</li>
|
|
<li>Make a <code class="docutils literal"><span class="pre">development</span></code> build of <em>geopandas</em></li>
|
|
<li>Make changes to code and add tests</li>
|
|
<li>Update the documentation</li>
|
|
<li>Submit a Pull Request</li>
|
|
</ol>
|
|
<p>Each of these 7 steps is detailed below.</p>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="forking-the-geopandas-repository-using-git">
|
|
<h2>1) Forking the <em>geopandas</em> repository using Git<a class="headerlink" href="#forking-the-geopandas-repository-using-git" title="Permalink to this headline">¶</a></h2>
|
|
<p>To the new user, working with Git is one of the more daunting aspects of contributing to <em>geopandas*</em>.
|
|
It can very quickly become overwhelming, but sticking to the guidelines below will help keep the process
|
|
straightforward and mostly trouble free. As always, if you are having difficulties please
|
|
feel free to ask for help.</p>
|
|
<p>The code is hosted on <a class="reference external" href="https://github.com/geopandas/geopandas">GitHub</a>. To
|
|
contribute you will need to sign up for a <a class="reference external" href="https://github.com/signup/free">free GitHub account</a>. We use <a class="reference external" href="http://git-scm.com/">Git</a> for
|
|
version control to allow many people to work together on the project.</p>
|
|
<p>Some great resources for learning Git:</p>
|
|
<ul class="simple">
|
|
<li>Software Carpentry’s <a class="reference external" href="http://swcarpentry.github.io/git-novice/">Git Tutorial</a></li>
|
|
<li><a class="reference external" href="https://www.atlassian.com/git/tutorials/what-is-version-control">Atlassian</a></li>
|
|
<li>the <a class="reference external" href="http://help.github.com/">GitHub help pages</a>.</li>
|
|
<li>Matthew Brett’s <a class="reference external" href="http://matthew-brett.github.com/pydagogue/">Pydagogue</a>.</li>
|
|
</ul>
|
|
<div class="section" id="getting-started-with-git">
|
|
<h3>Getting started with Git<a class="headerlink" href="#getting-started-with-git" title="Permalink to this headline">¶</a></h3>
|
|
<p><a class="reference external" href="http://help.github.com/set-up-git-redirect">GitHub has instructions</a> for installing git,
|
|
setting up your SSH key, and configuring git. All these steps need to be completed before
|
|
you can work seamlessly between your local repository and GitHub.</p>
|
|
</div>
|
|
<div class="section" id="forking">
|
|
<span id="contributing-forking"></span><h3>Forking<a class="headerlink" href="#forking" title="Permalink to this headline">¶</a></h3>
|
|
<p>You will need your own fork to work on the code. Go to the <a class="reference external" href="https://github.com/geopandas/geopandas">geopandas project
|
|
page</a> and hit the <code class="docutils literal"><span class="pre">Fork</span></code> button. You will
|
|
want to clone your fork to your machine:</p>
|
|
<div class="highlight-python"><div class="highlight"><pre>git clone git@github.com:your-user-name/geopandas.git geopandas-yourname
|
|
cd geopandas-yourname
|
|
git remote add upstream git://github.com/geopandas/geopandas.git
|
|
</pre></div>
|
|
</div>
|
|
<p>This creates the directory <cite>geopandas-yourname</cite> and connects your repository to
|
|
the upstream (main project) <em>geopandas</em> repository.</p>
|
|
<p>The testing suite will run automatically on Travis-CI once your pull request is
|
|
submitted. However, if you wish to run the test suite on a branch prior to
|
|
submitting the pull request, then Travis-CI needs to be hooked up to your
|
|
GitHub repository. Instructions for doing so are <a class="reference external" href="http://about.travis-ci.org/docs/user/getting-started/">here</a>.</p>
|
|
</div>
|
|
<div class="section" id="creating-a-branch">
|
|
<h3>Creating a branch<a class="headerlink" href="#creating-a-branch" title="Permalink to this headline">¶</a></h3>
|
|
<p>You want your master branch to reflect only production-ready code, so create a
|
|
feature branch for making your changes. For example:</p>
|
|
<div class="highlight-python"><div class="highlight"><pre>git branch shiny-new-feature
|
|
git checkout shiny-new-feature
|
|
</pre></div>
|
|
</div>
|
|
<p>The above can be simplified to:</p>
|
|
<div class="highlight-python"><div class="highlight"><pre>git checkout -b shiny-new-feature
|
|
</pre></div>
|
|
</div>
|
|
<p>This changes your working directory to the shiny-new-feature branch. Keep any
|
|
changes in this branch specific to one bug or feature so it is clear
|
|
what the branch brings to <em>geopandas</em>. You can have many shiny-new-features
|
|
and switch in between them using the git checkout command.</p>
|
|
<p>To update this branch, you need to retrieve the changes from the master branch:</p>
|
|
<div class="highlight-python"><div class="highlight"><pre>git fetch upstream
|
|
git rebase upstream/master
|
|
</pre></div>
|
|
</div>
|
|
<p>This will replay your commits on top of the latest geopandas git master. If this
|
|
leads to merge conflicts, you must resolve these before submitting your pull
|
|
request. If you have uncommitted changes, you will need to <code class="docutils literal"><span class="pre">stash</span></code> them prior
|
|
to updating. This will effectively store your changes and they can be reapplied
|
|
after updating.</p>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="creating-a-development-environment">
|
|
<span id="contributing-dev-env"></span><h2>2) Creating a development environment<a class="headerlink" href="#creating-a-development-environment" title="Permalink to this headline">¶</a></h2>
|
|
<p>A development environment is a virtual space where you can keep an independent installation of <em>geopandas</em>.
|
|
This makes it easy to keep both a stable version of python in one place you use for work, and a development
|
|
version (which you may break while playing with code) in another.</p>
|
|
<p>An easy way to create a <em>geopandas</em> development environment is as follows:</p>
|
|
<ul class="simple">
|
|
<li>Install either <a class="reference external" href="http://docs.continuum.io/anaconda/">Anaconda</a> or
|
|
<a class="reference external" href="http://conda.pydata.org/miniconda.html">miniconda</a></li>
|
|
<li>Make sure that you have <a class="reference internal" href="#contributing-forking"><span>cloned the repository</span></a></li>
|
|
<li><code class="docutils literal"><span class="pre">cd</span></code> to the <em>geopandas*</em> source directory</li>
|
|
</ul>
|
|
<p>Tell conda to create a new environment, named <code class="docutils literal"><span class="pre">geopandas_dev</span></code>, or any other name you would like
|
|
for this environment, by running:</p>
|
|
<div class="highlight-python"><div class="highlight"><pre>conda create -n geopandas_dev
|
|
</pre></div>
|
|
</div>
|
|
<p>For a python 3 environment:</p>
|
|
<div class="highlight-python"><div class="highlight"><pre>conda create -n geopandas_dev python=3.4
|
|
</pre></div>
|
|
</div>
|
|
<p>This will create the new environment, and not touch any of your existing environments,
|
|
nor any existing python installation.</p>
|
|
<p>To work in this environment, Windows users should <code class="docutils literal"><span class="pre">activate</span></code> it as follows:</p>
|
|
<div class="highlight-python"><div class="highlight"><pre>activate geopandas_dev
|
|
</pre></div>
|
|
</div>
|
|
<p>Mac OSX and Linux users should use:</p>
|
|
<div class="highlight-python"><div class="highlight"><pre>source activate geopandas_dev
|
|
</pre></div>
|
|
</div>
|
|
<p>You will then see a confirmation message to indicate you are in the new development environment.</p>
|
|
<p>To view your environments:</p>
|
|
<div class="highlight-python"><div class="highlight"><pre>conda info -e
|
|
</pre></div>
|
|
</div>
|
|
<p>To return to you home root environment:</p>
|
|
<div class="highlight-python"><div class="highlight"><pre><span class="n">deactivate</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>See the full conda docs <a class="reference external" href="http://conda.pydata.org/docs">here</a>.</p>
|
|
<p>At this point you can easily do a <em>development</em> install, as detailed in the next sections.</p>
|
|
</div>
|
|
<div class="section" id="installing-dependencies">
|
|
<h2>3) Installing Dependencies<a class="headerlink" href="#installing-dependencies" title="Permalink to this headline">¶</a></h2>
|
|
<p>To run <em>geopandas</em> in an development environment, you must first install
|
|
<em>geopandas</em>‘s dependencies. We suggest doing so using the following commands
|
|
(executed after your development environment has been activated):</p>
|
|
<div class="highlight-python"><div class="highlight"><pre>conda install -c conda-forge fiona shapely pyproj rtree
|
|
conda install pandas
|
|
</pre></div>
|
|
</div>
|
|
<p>This should install all necessary dependencies.</p>
|
|
</div>
|
|
<div class="section" id="making-a-development-build">
|
|
<h2>4) Making a development build<a class="headerlink" href="#making-a-development-build" title="Permalink to this headline">¶</a></h2>
|
|
<p>Once dependencies are in place, make an in-place build by navigating to the git
|
|
clone of the <em>geopandas</em> repository and running:</p>
|
|
<div class="highlight-python"><div class="highlight"><pre>python setup.py develop
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="making-changes-and-writing-tests">
|
|
<h2>5) Making changes and writing tests<a class="headerlink" href="#making-changes-and-writing-tests" title="Permalink to this headline">¶</a></h2>
|
|
<p><em>geopandas</em> is serious about testing and strongly encourages contributors to embrace
|
|
<a class="reference external" href="http://en.wikipedia.org/wiki/Test-driven_development">test-driven development (TDD)</a>.
|
|
This development process “relies on the repetition of a very short development cycle:
|
|
first the developer writes an (initially failing) automated test case that defines a desired
|
|
improvement or new function, then produces the minimum amount of code to pass that test.”
|
|
So, before actually writing any code, you should write your tests. Often the test can be
|
|
taken from the original GitHub issue. However, it is always worth considering additional
|
|
use cases and writing corresponding tests.</p>
|
|
<p>Adding tests is one of the most common requests after code is pushed to <em>geopandas</em>. Therefore,
|
|
it is worth getting in the habit of writing tests ahead of time so this is never an issue.</p>
|
|
<p>Like many packages, <em>geopandas</em> uses the <a class="reference external" href="http://nose.readthedocs.org/en/latest/index.html">Nose testing system</a> and the convenient
|
|
extensions in <a class="reference external" href="http://docs.scipy.org/doc/numpy/reference/routines.testing.html">numpy.testing</a>.</p>
|
|
<div class="section" id="writing-tests">
|
|
<h3>Writing tests<a class="headerlink" href="#writing-tests" title="Permalink to this headline">¶</a></h3>
|
|
<p>All tests should go into the <code class="docutils literal"><span class="pre">tests</span></code> directory. This folder contains many
|
|
current examples of tests, and we suggest looking to these for inspiration.</p>
|
|
<p>The <code class="docutils literal"><span class="pre">.util</span></code> module has some special <code class="docutils literal"><span class="pre">assert</span></code> functions that
|
|
make it easier to make statements about whether GeoSeries or GeoDataFrame
|
|
objects are equivalent. The easiest way to verify that your code is correct is to
|
|
explicitly construct the result you expect, then compare the actual result to
|
|
the expected correct result, using eg the function <code class="docutils literal"><span class="pre">assert_geoseries_equal</span></code>.</p>
|
|
</div>
|
|
<div class="section" id="running-the-test-suite">
|
|
<h3>Running the test suite<a class="headerlink" href="#running-the-test-suite" title="Permalink to this headline">¶</a></h3>
|
|
<p>The tests can then be run directly inside your Git clone (without having to
|
|
install <em>geopandas</em>) by typing:</p>
|
|
<div class="highlight-python"><div class="highlight"><pre><span class="n">nosetests</span> <span class="o">-</span><span class="n">v</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="updating-the-documentation">
|
|
<h2>6) Updating the Documentation<a class="headerlink" href="#updating-the-documentation" title="Permalink to this headline">¶</a></h2>
|
|
<p><em>geopandas</em> documentation resides in the <cite>doc</cite> folder. Changes to the docs are
|
|
make by modifying the appropriate file in the <cite>source</cite> folder within <cite>doc</cite>.
|
|
<em>geopandas</em> docs us reStructuredText syntax, <a class="reference external" href="http://www.sphinx-doc.org/en/stable/rest.html#rst-primer">which is explained here</a>
|
|
and the docstrings follow the <a class="reference external" href="https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt">Numpy Docstring standard</a>.</p>
|
|
<p>Once you have made your changes, you can build the docs by navigating to the <cite>doc</cite> folder and typing:</p>
|
|
<div class="highlight-python"><div class="highlight"><pre>make html
|
|
</pre></div>
|
|
</div>
|
|
<p>The resulting html pages will be located in <cite>doc/build/html</cite>.</p>
|
|
</div>
|
|
<div class="section" id="submitting-a-pull-request">
|
|
<h2>7) Submitting a Pull Request<a class="headerlink" href="#submitting-a-pull-request" title="Permalink to this headline">¶</a></h2>
|
|
<p>Once you’ve made changes and pushed them to your forked repository, you then
|
|
submit a pull request to have them integrated into the <em>geopandas</em> code base.</p>
|
|
<p>You can find a pull request (or PR) tutorial in the <a class="reference external" href="https://help.github.com/articles/using-pull-requests/">GitHub’s Help Docs</a>.</p>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="about.html" class="btn btn-neutral float-right" title="About">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|
|
|
|
|
<a href="reference.html" class="btn btn-neutral" title="Reference"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2013-2016, GeoPandas developers.
|
|
</p>
|
|
</div>
|
|
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT:'./',
|
|
VERSION:'0.2-py3.5.egg',
|
|
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>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.StickyNav.enable();
|
|
});
|
|
</script>
|
|
|
|
|
|
</body>
|
|
</html> |