Tutorial

This tutorial walks through the basics of creating a Github Pages site for a Python package. It focuses on sphinx.

The tutorial will show off the Python package mycybergis in cybergis/github-pages-demo and an example notebook using the package.

Note

Before you start, please setup a Github account, an environment with Git and Sphinx installed and have some kind of Python package management software. I recommend venv or conda. The tutorial assumes you have Sphinx installed and some way to install Python packages.

Tutorial Contents:

• 1. Sphinx-Quickstart
• 2. Intro to RST
• 3. Autodocs
• 4. nbsphinx
• 5. Deploying to Github Pages
• 6. Advanced Topics
  • 6.1. Sphinx Themes
  • 6.2. Sphinx Alternatives
  • 6.3. Checking Workflows Locally
  • 6.4. Other Workflows