Contributing Documentation

Warning

This site documents Glimpse 2.0.0. It is a work in progress, and still has a long way to go.

For Glimpse v1 documentation, please visit getglimpse.com/Docs.

Glimpse documentation is stored in GitHub and is hosted on the ReadTheDocs.org platform at docs.getglimpse.com.

Any individual page in the Glimpse documentation can be edited by clicking “Edit on GitHub” link at the top of the page.

For larger contributions, or to more quickly work with multiple pages, ReadTheDocs can be run locally.

Installing ReadTheDocs

ReadTheDocs is based on the popular open source project Sphinx. Sphinx is built in Python and leverages a powerful Markdown-like language called reStructuredText (reST).

The steps to install are:

  1. Download and Install Python 3.5 (or later) from the Python Downloads page.

Tip

To determine the current version of Python installed on your machine, use python --version

Note

On OS X, the Python 3.x binary is python3.

  1. Using git, clone the Glimpse Docs repository locally: git clone git@github.com:Glimpse/Docs.git docs
  2. Change into the docs directory: cd docs
  3. Using pip, Python’s package manager, install Sphinx: pip install sphinx

Note

On OS X, the Python 3.x package manager is pip3.

  1. Install the ReadTheDocs’s Sphinx theme: pip install -U sphinx_rtd_theme
  2. Install sphinx-autobuild: pip install sphinx-autobuild
  3. Run sphinx-autobuild with these two options: sphinx-autobuild source build/html
  4. Browse to http://localhost:8000/

Editing Documentation

Edit any .rst file in the source directory. When changes are saved, sphinx-autobuild will automatically rebuild the site and refresh your browser.

For help with reStructuredText itself, use the reStructuredText Primer in Sphinx’s documentation.