mkdocs.yml

site_name: PVGeo
site_author: Bane Sullivan
site_description: "PVGeo is a code base tailored to the visualization of spatially referenced data in the geosciences on the ParaView software platform. "
repo_url: https://github.com/OpenGeoVis/PVGeo
repo_name: PVGeo on GitHub
site_url: http://pvgeo.org/
edit_uri: ""
copyright: Copyright &copy 2017-2018, <a href="http://banesullivan.com">Bane Sullivan</a>

google_analytics:
  - 'UA-115959679-1'
  - 'auto'

extra:
  disqus: 'pvgeo'
  social: # check https://fontawesome.com/icons?d=gallery for more icons
    - type: 'twitter'
      link: 'https://twitter.com/OpenGeoVis'
    - type: 'slack'
      link: 'http://slack.pvgeo.org'
    - type: 'github'
      link: 'https://github.com/OpenGeoVis'
    - type: 'envelope'
      link: 'mailto:info@pvgeo.org'
    - type: 'vimeo'
      link: 'https://vimeo.com/user82050125'

theme:
    name: material
    feature:
        tabs: true
    palette:
        primary: 'blue-grey'
        accent: 'red'
    custom_dir: custom_theme
    favicon: 'img/PVGeo_icon.png'
    logo: 'img/globe_small.png'

# extra_css:
#     - stylesheets/extra.css


markdown_extensions:
    # Make sure parent directory is in pyhton path when building docs
    - md_pvgeo_extension


    - smarty
    - toc:
        permalink: true
    - admonition
    - codehilite:
        #linenums: true
        guess_lang: true
    - meta # see this page: https://squidfunk.github.io/mkdocs-material/extensions/metadata/
    - footnotes # see this page: https://squidfunk.github.io/mkdocs-material/extensions/footnotes/
    - pymdownx.b64 # local images
    - pymdownx.superfences # code snippets
    - pymdownx.inlinehilite #example: import the NumPy module by `#!py import numpy`
    - pymdownx.caret # ability to add exponents with caret: a^3
    - pymdownx.details # collapsible widgets
    - pymdownx.tasklist:
        custom_checkbox: true

plugins:
    - search

nav:
- Overview:
    - Home: index.md
    - Why PVGeo?: overview/why-pvgeo.md
    - Getting Started: overview/getting-started.md
    - Featured: overview/featured.md
    - Upcoming: overview/upcoming.md
    - AGU 2018: overview/agu-2018.md

# Each of the different Examples:
- Examples:
    - About Examples: examples/about-examples.md
    - Contents: examples/contents.md
    #- Base Classes: examples/base.md
    - General Filters:
        - Add Cell Connectivity to Points: examples/filters-general/add-cell-connectivity-to-points.md
        - Append Cell Centers: examples/filters-general/append-cell-centers.md
        - Array Math: examples/filters-general/array-math.md
        - Arrays to RGBA: examples/filters-general/arrays-to-rgba.md
        - Combine Tables: examples/filters-general/combine-tables.md
        - Convert Units: examples/filters-general/convert-units.md
        - Extract Array: examples/filters-general/extract-array.md
        - Extract Cell Centers: examples/filters-general/extract-cell-centers.md
        - Extract Points: examples/filters-general/extract-points.md
        - Iterate Over Points: examples/filters-general/iterate-over-points.md
        - Longitude/Latitude to UTM: examples/filters-general/lonlat-to-utm.md
        - Many Slices Along Axis: examples/filters-general/many-slices-along-axis.md
        - Many Slices Along Points: examples/filters-general/many-slices-along-points.md
        - Normalize Array: examples/filters-general/normalize-array.md
        - Percent Threshold: examples/filters-general/percent-threshold.md
        - Points to Tube: examples/filters-general/points-to-tube.md
        - Reshape Table: examples/filters-general/reshape-table.md
        - Rotate Points: examples/filters-general/rotate-points.md
        - Rotation Tool: examples/filters-general/rotation-tool.md
        - Slice Through Time: examples/filters-general/slice-through-time.md
        - Slide Slice Along Points: examples/filters-general/slide-slice-along-points.md
        - Split Table On Array: examples/filters-general/split-table-on-array.md
        - Voxelize Points: examples/filters-general/voxelize-points.md
    - General Readers:
        - Binary Packed Data: examples/readers-general/binary-packed-data.md
        - Delimited Text: examples/readers-general/delimited-text.md
        - Madagascar SSRSF: examples/readers-general/madagascar-ssrsf.md
        - XYZ Files: examples/readers-general/xyz-reader.md
    - Grid Tools:
        - ESRI Grid Reader: examples/grids/esri-grid.md
        - Extract Topography: examples/grids/extract-topography.md
        - Flip Grid Axii: examples/grids/reverse-grid-axii.md
        - Landsat Rasters: examples/grids/raster.md
        - Surfer Grids: examples/grids/surfer-grid.md
        - Table to Uniform Grid: examples/grids/table-to-uniform-grid.md
        - Translate Origin of Grid: examples/grids/translate-origin-of-grid.md
        - Write Cell Centers: examples/grids/write-cell-centers.md
    - GSLIB & SGeMS:
        - GSLib Tables: examples/gslib/gslib.md
        - SGeMS Grids: examples/gslib/sgems-grid.md
    - Interface:
        - Points to PolyData: examples/interface/points-to-polydata.md
    - Model Building:
        - Create Earth Source: examples/model-building/create-earth-source.md
        - Create Rectilinear Grid: examples/model-building/create-rectilinear-grid.md
        - Create Uniform Grid: examples/model-building/create-uniform-grid.md
    - Tunneling:
        - Animate TBM: examples/tunneling/animate-tbm.md
    - UBC Mesh Tools:
        - Append Model: examples/ubc/add-model.md
        - Read Gravity Observations: examples/ubc/grav-obs.md
        - Read Magnetics Observations: examples/ubc/mag-obs.md
        - Read OcTree: examples/ubc/octree.md
        - Read Tensor Meshes: examples/ubc/tensor-grids.md
        - Read Topography: examples/ubc/topo.md

- Docs:
    - Docs: http://docs.pvgeo.org

- PV Macros:
    - About pvmacros: pvmacros/about-pvmacros.md
    - Export:
        - Export as VTKjs:  pvmacros/export/exportvtkjs.md
    - Vis:
        - Camera: pvmacros/vis/camera.md

- Resources:
    - External References: resources/references.md
    - Color Maps: cmaps.md
    - Entering Virtual Reality: virtual-reality/entering-virtual-reality.md
    - Editing the Axes: resources/edit-axes.md
    - Editing the Render View: resources/edit-render-view.md
    - Save Camera Views: resources/save-camera-locations.md
    - Scripts:
        - About Scripts: scripts/about-scripts.md
        - Example Script: scripts/example-script.md
    - Understand VTK Data Types: resources/understand-vtk.md

- Development Guide:
    - Contributing: dev-guide/contributing.md
    - Repo Structure: dev-guide/repo-structure.md
    - Build Your Own Plugins: dev-guide/build-your-own-plugins.md
    - Style Guide: dev-guide/style.md
    - Templates: dev-guide/templates.md
    - Snippets:
        Composite Writer: dev-guide/snippets/composite-data-writers.md

- HDF5:
    - HDF5: http://hdf5.pvgeo.org