Skip to content

Commit

Permalink
Merge pull request #162 from jbouffard/rtd
Browse files Browse the repository at this point in the history
Read The Docs
  • Loading branch information
Jacob Bouffard committed May 3, 2017
2 parents 9aed355 + b1492f0 commit 6b9de12
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 16 deletions.
4 changes: 3 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ GeoPySpark
.. image:: https://travis-ci.org/locationtech-labs/geopyspark.svg?branch=master
:target: https://travis-ci.org/locationtech-labs/geopyspark

.. image:: https://readthedocs.org/projects/geopyspark/badge/?version=latest
:target: https://geopyspark.readthedocs.io/en/latest/?badge=latest

``GeoPySpark`` provides Python bindings for working with geospatial data using `PySpark <http://spark.apache.org/docs/latest/api/python/pyspark.html>`_
It will provide interfaces into GeoTrellis and GeoMesa LocationTech frameworks.
It is currently under development, and has just entered alpha.
Expand Down Expand Up @@ -93,4 +96,3 @@ Contributing
Any kind of feedback and contributions to GeoPySpark is always welcomed.
A CLA is required for contribution, see `Contributing <docs/contributing.rst>`_ for more
information.
>>>>>>> Expanded README
25 changes: 17 additions & 8 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,20 @@
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
from os import path
import sys
from geopyspark.geopyspark_utils import setup_environment
import subprocess

setup_environment()
sys.path.insert(0, os.path.abspath('../geopyspark/'))
if 'SPARK_HOME' not in os.environ.keys():
spark_url = 'http://d3kbcqa49mib13.cloudfront.net/spark-2.1.0-bin-hadoop2.7.tgz'
subprocess.call(['curl', '-L', spark_url, '-O'])
subprocess.call(['tar', '-xvf', 'spark-2.1.0-bin-hadoop2.7.tgz'])
os.environ['SPARK_HOME'] = './spark-2.1.0-bin-hadoop2.7/'

jar = 'geotrellis-backend-assembly-0.1.0.jar'
url = 'https://github.com/locationtech-labs/geopyspark/releases/download/v0.1.0RC1/'
subprocess.call(['curl', '-L', url+jar, '-o', '../geopyspark/jars/' + jar])
sys.path.insert(0, path.abspath('../'))


# -- General configuration ------------------------------------------------
Expand Down Expand Up @@ -88,7 +97,10 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'

import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand All @@ -99,7 +111,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
#html_static_path = ['_static']


# -- Options for HTMLHelp output ------------------------------------------
Expand Down Expand Up @@ -157,6 +169,3 @@
author, 'GeoPySpark', 'One line description of project.',
'Miscellaneous'),
]



4 changes: 0 additions & 4 deletions docs/geopyspark.geotrellis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,29 +12,25 @@ geopyspark.geotrellis.catalog module

.. automodule:: geopyspark.geotrellis.catalog
:members:
:undoc-members:
:inherited-members:

geopyspark.geotrellis.constants module
---------------------------------------

.. automodule:: geopyspark.geotrellis.constants
:members:
:undoc-members:
:inherited-members:

geopyspark.geotrellis.geotiff_rdd module
-----------------------------------------

.. automodule:: geopyspark.geotrellis.geotiff_rdd
:members:
:undoc-members:
:inherited-members:

geopyspark.geotrellis.rdd module
---------------------------------

.. automodule:: geopyspark.geotrellis.rdd
:members:
:undoc-members:
:inherited-members:
3 changes: 0 additions & 3 deletions docs/geopyspark.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,9 @@ geopyspark

.. autoclass:: geopyspark.geopycontext.AvroRegistry
:members:
:undoc-members:

.. autoclass:: geopyspark.geopycontext.AvroSerializer
:members:
:undoc-members:

.. autoclass:: geopyspark.geopycontext.GeoPyContext
:members:
:undoc-members:

0 comments on commit 6b9de12

Please sign in to comment.