From eba34a32cf447e6842e3a1f3673af6ae9fd155ba Mon Sep 17 00:00:00 2001 From: Matthew Perry Date: Thu, 24 Mar 2016 08:39:56 -0400 Subject: [PATCH] round of edits per pr review --- AUTHORS.txt | 60 +++++++++++------------ CODE_OF_CONDUCT.md => CODE_OF_CONDUCT.txt | 7 ++- docs/community.rst | 14 +++--- docs/conf.py | 13 +++-- docs/cookbook.rst | 10 ++++ docs/developers.rst | 8 +++ docs/index.rst | 18 +++---- docs/intro.rst | 4 -- docs/python_manual.rst | 2 +- docs/topics.rst | 4 +- 10 files changed, 78 insertions(+), 62 deletions(-) rename CODE_OF_CONDUCT.md => CODE_OF_CONDUCT.txt (87%) delete mode 100644 docs/intro.rst diff --git a/AUTHORS.txt b/AUTHORS.txt index 3e35b11f..63a29e2c 100644 --- a/AUTHORS.txt +++ b/AUTHORS.txt @@ -1,34 +1,34 @@ Authors -======= +------- -Aldo Culquicondor -Alessandro Amici -Alexander -Amit Kapadia -AsgerPetersen -Bas Couwenberg -Brendan Ward -Etienne B. Racine -Even Rouault -Jacques Tardie -James McBride -James Seppi -Jeffrey Gerard -Johan Van de Wauw -Joshua Arnott -Kelsey Jordahl -Kevin Wurster -Martijn Visser -Matt Savoie -Matthew Perry -Maxim Dubinin -Mike Toews -Nat Wilson -Patrick Young -Robin Wilson -Ryan Grout -Sean Gillies -Trevor R.H. Clarke -cgohlke +* Aldo Culquicondor +* Alessandro Amici +* Alexander +* Amit Kapadia +* AsgerPetersen +* Bas Couwenberg +* Brendan Ward +* Etienne B. Racine +* Even Rouault +* Jacques Tardie +* James McBride +* James Seppi +* Jeffrey Gerard +* Johan Van de Wauw +* Joshua Arnott +* Kelsey Jordahl +* Kevin Wurster +* Martijn Visser +* Matt Savoie +* Matthew Perry +* Maxim Dubinin +* Mike Toews +* Nat Wilson +* Patrick Young +* Robin Wilson +* Ryan Grout +* Sean Gillies +* Trevor R.H. Clarke +* cgohlke See also https://github.com/mapbox/rasterio/graphs/contributors. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.txt similarity index 87% rename from CODE_OF_CONDUCT.md rename to CODE_OF_CONDUCT.txt index 01b8644f..ad8236fd 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.txt @@ -1,4 +1,5 @@ -# Contributor Code of Conduct +Contributor Code of Conduct +--------------------------- As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. @@ -19,4 +20,6 @@ This code of conduct applies both within project spaces and in public spaces whe Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers. -This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/) +This Code of Conduct is adapted from the `Contributor Covenant`_, version 1.2.0, available at http://contributor-covenant.org/version/1/2/0/ + +.. _Contributor Covenant: http://contributor-covenant.org diff --git a/docs/community.rst b/docs/community.rst index f9c428f3..41e62ea6 100644 --- a/docs/community.rst +++ b/docs/community.rst @@ -5,11 +5,13 @@ Community .. todo:: This is just a placeholder page to explain the use and development of rasterio. - + + If you have a project that uses rasterio, please contact us at https://github.com/mapbox/rasterio/issues Who is using rasterio? ---------------------- +* The `Conservation Biology Institute`_ uses rasterio to provide `geoprocessing of NetCDF files`_. * `Mapbox`_ uses rasterio to process satellite imagery for it's global satellite base maps. * Mary Marek-Spartz's masters thesis compares the map algebra tools of the proprietary ESRI ArcPy library and the open source Rasterio library. https://github.com/alfalimajuliett/masters-thesis @@ -26,12 +28,6 @@ Rio plugins In addition to the core ``rio`` commands, visit the `Rio plugin registry`_ for a list of external plugins. - -Code of conduct ---------------- - -.. include:: ../CODE_OF_CONDUCT.md - Who are the rasterio developers? -------------------------------- @@ -39,5 +35,9 @@ Who are the rasterio developers? .. include:: ../AUTHORS.txt +.. include:: ../CODE_OF_CONDUCT.txt + .. _Mapbox: https://mapbox.com .. _Rio plugin registry: https://github.com/mapbox/rasterio/wiki/Rio-plugin-registry +.. _Conservation Biology Institute: http://consbio.org/ +.. _geoprocessing of NetCDF files: https://github.com/consbio/clover diff --git a/docs/conf.py b/docs/conf.py index 2c0b61fc..ffdee8ca 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -63,10 +63,15 @@ author = u'Sean Gillies' # |version| and |release|, also used in various other places throughout the # built documents. # -# The short X.Y version. -version = u'1.0' -# The full version, including alpha/beta/rc tags. -release = u'1.0' +# Parse the version from the rasterio module. +with open('../rasterio/__init__.py') as f: + for line in f: + if line.find("__version__") >= 0: + version = line.split("=")[1].strip() + version = version.strip('"') + version = version.strip("'") + continue +release = version # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/cookbook.rst b/docs/cookbook.rst index e26e7f0e..4ef3fef0 100644 --- a/docs/cookbook.rst +++ b/docs/cookbook.rst @@ -1,3 +1,13 @@ ================= Rasterio Cookbook ================= + +.. todo:: + + Examples of using rasterio to handle tasks from typical + GIS and remote sensing workflows. + + With inspiration from + + * https://pcjericks.github.io/py-gdalogr-cookbook/ + * https://github.com/dwtkns/gdal-cheat-sheet diff --git a/docs/developers.rst b/docs/developers.rst index 5aa0d070..254d6b3e 100644 --- a/docs/developers.rst +++ b/docs/developers.rst @@ -5,3 +5,11 @@ Developers guide Everything developers need to know to get a dev environment running, run tests, modify code and submit a successful PR. + + Currently most of this information lives on the wiki. + + * https://github.com/mapbox/rasterio/wiki/Development-Guide + * https://github.com/mapbox/rasterio/wiki/Exposing-GDAL-Functionality + * https://github.com/mapbox/rasterio/wiki/Cython-and-GDAL + + The long term goal is to consolidate into this document. diff --git a/docs/index.rst b/docs/index.rst index e37a94e2..183ed81e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,15 +1,10 @@ -.. rasterio documentation master file, created by - sphinx-quickstart on Thu Mar 17 07:05:00 2016. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - Rasterio Documentation ====================== .. warning:: This is not the official documentation. Not yet. - This is a draft and everything here is subject to change. - + This is a draft and everything here is subject to change. + For now, please refer to https://github.com/mapbox/rasterio for documentation. @@ -20,19 +15,19 @@ Rasterio employs GDAL_ under the hood for file I/O and raster formatting. Its functions typically accept and return Numpy ndarrays. Rasterio is designed to make working with geospatial raster data more productive and more fun. -You can download from pypi and todo quick link to install +Install with pip (see the complete :doc:`installation docs ` ) .. code:: pip install rasterio -And a quick example +And an example of use in python -.. code:: +.. code:: python import rasterio with rasterio.open('data.tif') as src: - array = src.read() + array = src.read() Contents: @@ -46,7 +41,6 @@ Contents: community - Indices and tables ================== diff --git a/docs/intro.rst b/docs/intro.rst deleted file mode 100644 index 6eca797f..00000000 --- a/docs/intro.rst +++ /dev/null @@ -1,4 +0,0 @@ -Introduction -============= - - diff --git a/docs/python_manual.rst b/docs/python_manual.rst index 4dc5d4b6..cda7946c 100644 --- a/docs/python_manual.rst +++ b/docs/python_manual.rst @@ -21,6 +21,6 @@ This user's manual is for Python developers who want a clean API for accessing r working_with_datasets writing topics - osgeo_gdal_migration developers cookbook + osgeo_gdal_migration diff --git a/docs/topics.rst b/docs/topics.rst index fabba40f..3aaad397 100644 --- a/docs/topics.rst +++ b/docs/topics.rst @@ -1,5 +1,5 @@ -Topics -====== +General Concepts +================ .. toctree::