GeoNode Documentation

Warning

Documentation has been migrated to MkDocs and is now maintained under the main GeoNode repo. This repository must be considered deprecated and will be archived soon.

How to write Documentation

GeoNode uses reStructuredText with Sphinx . Writing style should follow the same policies as GeoServer does in their Documentation Style Guide

Sphinx Syntax

• For more information, please see:

  • RST Quick Reference
  • Comprehensive guide to reStructuredText
  • Sphinx reStructuredText Primer

Build with Docker

• Build the local Docker image docker build . -t geonode/docs
• Run the container docker run --rm -it -p 8000:8000 -v ./:/docs geonode/docs
• Build html, rebuild on changes and automatically run preview server:

  make watch
  # Open http://localhost:8000 from the host

• Build html and review the output manually:

  make html
  cd _build/en/html
  python -m http.server 
  # Open http://localhost:8000 from the host

• Build PDF:

  make latexpdf