-
- {# SIDE NAV, TOGGLES ON MOBILE #}
-
-
-
-
- {# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
-
-
-
- {# PAGE CONTENT #}
-
-
-
- {% block body %}{% endblock %}
-
- {% include "footer.html" %}
-
-
-
-
-
-
- {% include "versions.html" %}
-
- {% if not embedded %}
-
-
- {% endif %}
-
- {# STICKY NAVIGATION #}
- {% if theme_sticky_navigation %}
-
- {% endif %}
-
- {%- block footer %} {% endblock %}
-
-
-
diff --git a/doc/_templates/page.html b/doc/_templates/page.html
deleted file mode 100644
index 9fd0405d..00000000
--- a/doc/_templates/page.html
+++ /dev/null
@@ -1,3 +0,0 @@
-{% extends "!page.html" %}
-{# add our custom css and js #}
-{% set css_files = css_files + ["_static/bootstrap.css", "_static/codehilite.css", "_static/custom.css", "_static/rtd_bootstrap.css"] %}
diff --git a/doc/about.rst b/doc/about.rst
new file mode 100644
index 00000000..fb481c8c
--- /dev/null
+++ b/doc/about.rst
@@ -0,0 +1,9 @@
+About Us
+========
+
+GeoViews was developed through a collaboration between `Continuum
+Analytics `_ and the `Met Office
+`_. GeoViews is completely `open source
+`_, available under a BSD license
+freely for both commercial and non-commercial use.
+
diff --git a/doc/builder b/doc/builder
deleted file mode 160000
index 260db18c..00000000
--- a/doc/builder
+++ /dev/null
@@ -1 +0,0 @@
-Subproject commit 260db18c5bc4cecb67c6b6ca3bef6c3a039d7a14
diff --git a/doc/conf.py b/doc/conf.py
index 052c4e93..fda01b0b 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -1,98 +1,39 @@
# -*- coding: utf-8 -*-
-import sys, os
-sys.path.insert(0, os.getcwd())
+from nbsite.shared_conf import *
-from builder.shared_conf import * # noqa (API import)
-
-paths = ['../param/', '.', '..']
-add_paths(paths)
-
-# # General information about the project.
project = u'GeoViews'
-copyright = u'2016, GeoViews developers'
authors = u'GeoViews developers'
-module = 'geoviews'
-description = 'Geographic visualizations for HoloViews'
-
-
-# # The short X.Y version.
-version = u'v0.1'
-# The full version, including alpha/beta/rc tags.
-release = u'v0.1'
-
-# Override default theme
-import sphinx_rtd_theme
-html_theme = "sphinx_rtd_theme"
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-html_logo = '_static/logo.png'
-html_favicon = '_static/favicon.ico'
-
-# -------------------------------------------------------------------------
-# -- The remaining items are less likely to need changing for a new project
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = ['_build', 'test_data', 'reference_data', 'nbpublisher',
- 'builder']
-
-# The name for this set of Sphinx documents. If None, it defaults to
-# " v documentation".
-html_title = project
-
-# 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', 'builder/_shared_static']
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = module+'doc'
-
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-# author, documentclass [howto, manual, or own class]).
-latex_documents = [
- ('index', module+'.tex', project+u' Documentation', authors, 'manual'),
-]
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
- ('index', module, project+u' Documentation', [authors], 1)
-]
-# If true, show URL addresses after external links.
-#man_show_urls = False
-
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
-texinfo_documents = [
- ('index', project, project+u' Documentation', authors, project, description,
- 'Miscellaneous'),
-]
-
-
-# Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'http://docs.python.org/': None,
- 'http://ipython.org/ipython-doc/2/': None,
- 'http://ioam.github.io/param/': None}
-
-js_includes = ['js/theme.js', 'bootstrap.js', 'custom.js', 'require.js']
-
-from builder.paramdoc import param_formatter
-from nbpublisher import nbbuild
-
-
-def setup(app):
- app.connect('autodoc-process-docstring', param_formatter)
- for js in js_includes:
- app.add_javascript(js)
-
- try:
- import runipy # noqa (Warning import)
- nbbuild.setup(app)
- except:
- print('RunIPy could not be imported; pages including the '
- 'Notebook directive will not build correctly')
+copyright = u'2017 ' + authors
+description = 'Geographic visualizations for HoloViews.'
+
+import geoviews
+version = release = str(geoviews.__version__)
+
+html_static_path += ['_static']
+html_theme = 'sphinx_ioam_theme'
+html_theme_options = {
+ 'logo':'geoviews-logo.png',
+ 'favicon':'favicon.ico',
+ 'custom_css':'geoviews.css'
+}
+
+_NAV = (
+ ('User Guide', 'user_guide/index'),
+ ('About', 'about')
+)
+
+html_context.update({
+ 'PROJECT': project,
+ 'DESCRIPTION': description,
+ 'AUTHOR': authors,
+ 'WEBSITE_SERVER': 'https://ioam.github.io/geoviews',
+ 'VERSION': version,
+ 'NAV': _NAV,
+ 'LINKS': _NAV,
+ 'SOCIAL': (
+ ('Gitter', '//gitter.im/ioam/holoviews'),
+ ('Twitter', '//twitter.com/holoviews'),
+ ('Github', '//github.com/ioam/geoviews'),
+ )
+})
diff --git a/doc/index.rst b/doc/index.rst
index c593b506..3b9dbff5 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -1,18 +1,22 @@
-.. GeoViews documentation master file
+********
+GeoViews
+********
-.. raw:: html
- :file: latest_news.html
-Introduction
-____________
+**Geographic visualizations for HoloViews**
+
.. notebook:: geoviews Homepage.ipynb
+
+Please see the `User Guide `_ for further documentation.
+
+
Installation
------------
-You can then install GeoViews and its other dependencies using conda,
-many users will want iris and/or xarray as well::
+You can install GeoViews and its other dependencies using conda, many
+users will want iris and/or xarray as well::
conda install -c conda-forge -c ioam holoviews geoviews
# (Optional)
@@ -27,28 +31,17 @@ the notebooks to run locally, and run them using the Jupyter notebook::
cd geoviews-examples
jupyter notebook
-------------
-
-Support
-_______
-
-GeoViews was developed through a collaboration between
-`Continuum Analytics `_ and the `Met Office
-`_. GeoViews is completely `open source
-`_, available under a BSD license
-freely for both commercial and non-commercial use. Please file
-bug reports and feature requests on our
-`github site `_.
+
+Please feel free to report `issues
+`_ or `contribute code
+`_. You are also
+welcome to chat with the developers on `gitter
+`_.
.. toctree::
- :titlesonly:
:hidden:
:maxdepth: 2
- Home
- Projections
- Geometries
- Working with Gridded Data I
- Working with Gridded Data II
- Working with Bokeh
- Github source
+ Introduction
+ User Guide
+ About
diff --git a/doc/latest_news.html b/doc/latest_news.html
index 66481f9c..e69de29b 100644
--- a/doc/latest_news.html
+++ b/doc/latest_news.html
@@ -1,5 +0,0 @@
-
diff --git a/doc/nbpublisher b/doc/nbpublisher
deleted file mode 160000
index 73c7e2d2..00000000
--- a/doc/nbpublisher
+++ /dev/null
@@ -1 +0,0 @@
-Subproject commit 73c7e2d288b8000a6cd1123dc2364b2b63d6a696
diff --git a/doc/user_guide/index.rst b/doc/user_guide/index.rst
new file mode 100644
index 00000000..4d95ee4d
--- /dev/null
+++ b/doc/user_guide/index.rst
@@ -0,0 +1,31 @@
+**********
+User Guide
+**********
+
+Contents:
+
+* `Projections `_
+ Plotting data on various geographic projections.
+
+* `Geometries `_
+ Working with geometries and shapes.
+
+* `Gridded Datasets I `_
+ Make full use of multidimensional gridded datasets stored in netCDF and other common formats.
+
+* `Gridded Datasets II `_
+ Explore complex datasets quickly with lower dimensional views.
+
+* `Working with Bokeh `_
+ Using the Bokeh extension for more interactivity.
+
+.. toctree::
+ :titlesonly:
+ :hidden:
+ :maxdepth: 2
+
+ Projections
+ Geometries
+ Gridded Datasets I
+ Gridded Datasets II
+ Working with Bokeh
diff --git a/doc/Geometries.ipynb b/notebooks/user_guide/Geometries.ipynb
similarity index 100%
rename from doc/Geometries.ipynb
rename to notebooks/user_guide/Geometries.ipynb
diff --git a/doc/Gridded_Datasets_I.ipynb b/notebooks/user_guide/Gridded_Datasets_I.ipynb
similarity index 100%
rename from doc/Gridded_Datasets_I.ipynb
rename to notebooks/user_guide/Gridded_Datasets_I.ipynb
diff --git a/doc/Gridded_Datasets_II.ipynb b/notebooks/user_guide/Gridded_Datasets_II.ipynb
similarity index 100%
rename from doc/Gridded_Datasets_II.ipynb
rename to notebooks/user_guide/Gridded_Datasets_II.ipynb
diff --git a/doc/Projections.ipynb b/notebooks/user_guide/Projections.ipynb
similarity index 100%
rename from doc/Projections.ipynb
rename to notebooks/user_guide/Projections.ipynb
diff --git a/doc/Working_with_Bokeh.ipynb b/notebooks/user_guide/Working_with_Bokeh.ipynb
similarity index 100%
rename from doc/Working_with_Bokeh.ipynb
rename to notebooks/user_guide/Working_with_Bokeh.ipynb
diff --git a/doc/assets/boundaries/boundaries.dbf b/notebooks/user_guide/assets/boundaries/boundaries.dbf
similarity index 100%
rename from doc/assets/boundaries/boundaries.dbf
rename to notebooks/user_guide/assets/boundaries/boundaries.dbf
diff --git a/doc/assets/boundaries/boundaries.shp b/notebooks/user_guide/assets/boundaries/boundaries.shp
similarity index 100%
rename from doc/assets/boundaries/boundaries.shp
rename to notebooks/user_guide/assets/boundaries/boundaries.shp
diff --git a/doc/assets/boundaries/boundaries.shx b/notebooks/user_guide/assets/boundaries/boundaries.shx
similarity index 100%
rename from doc/assets/boundaries/boundaries.shx
rename to notebooks/user_guide/assets/boundaries/boundaries.shx
diff --git a/doc/assets/cities.csv b/notebooks/user_guide/assets/cities.csv
similarity index 100%
rename from doc/assets/cities.csv
rename to notebooks/user_guide/assets/cities.csv
diff --git a/doc/assets/referendum.csv b/notebooks/user_guide/assets/referendum.csv
similarity index 100%
rename from doc/assets/referendum.csv
rename to notebooks/user_guide/assets/referendum.csv
diff --git a/doc/assets/results.json b/notebooks/user_guide/assets/results.json
similarity index 100%
rename from doc/assets/results.json
rename to notebooks/user_guide/assets/results.json