Creating Github Pages for Code

The Github repository can be found here.

Author: Alexander Michels

It’s increasingly common for software and projects to have documentation sites with auto-generated docs and/or examples using Jupyter notebooks. Some examples include:

• geopanda documentation and examples

• osmnx documentation

Some CyberGIS Center projects with sites include:

• cybergisx-cli (made with MkDocs)

• cybergis-compute-python-sdk (made with Sphinx)

This site has the goal of walking through how to create one of these sites with Sphinx. At the end of the tutorial, you could end up with the Examples page and User Reference page.

Contents:

• Tutorial
  • 1. Sphinx-Quickstart
  • 2. Intro to RST
  • 3. Autodocs
  • 4. nbsphinx
  • 5. Deploying to Github Pages
  • 6. Advanced Topics
• Examples
  • Example Notebook
• User Reference
  • mycybergis.uiuc module

Indices and tables

• Index

• Module Index

• Search Page