diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3b112a3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,44 @@ +Guidelines +========== + +Contributions to GeoPandas are very welcome. They are likely to +be accepted more quickly if they follow these guidelines. + +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. + +In general, GeoPandas follows the conventions of the pandas project +where applicable. Please read [pandas contributing +guidelines](https://github.com/pydata/pandas/blob/master/CONTRIBUTING.md). + +In particular, when submitting a pull request: + +- All existing tests should pass. Please make sure that the test + suite passes, both locally and on + [Travis CI](https://travis-ci.org/kjordahl/geopandas). 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 + [getting started docs](http://about.travis-ci.org/docs/user/getting-started/). + +- New functionality should include tests. Please write reasonable + tests for your code and make sure that they pass on your pull request. + +- 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. + +Improving the documentation and testing for code already in GeoPandas +is a great way to get started if you'd like to make a contribution. + +Style +----- + +- Follow PEP 8 when possible. + +- 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 rather than relative imports. diff --git a/LICENSE.txt b/LICENSE.txt index 650ca20..15d5aed 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,4 +1,4 @@ -Copyright (c) 2013, Enthought, Inc. +Copyright (c) 2013, GeoPandas developers. All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/doc/Makefile b/doc/Makefile index 4d9874a..f507382 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -5,14 +5,14 @@ SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = -BUILDDIR = _build +BUILDDIR = build # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source # the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html deleted file mode 100644 index aa59819..0000000 --- a/doc/_templates/layout.html +++ /dev/null @@ -1,11 +0,0 @@ -{% extends "!layout.html" %} -{%- set rellinks = [] %} -{% block rootrellink %} -