Welcome to howto-sphinx’s documentation!

Steps for creating documentation for open source software projects with Sphinx.

This guide demonstrates how to create html documentation using Sphinx and publish/host the pages on a public platform.

Note

This guide is currently a work-in-progress and will periodically undergo updates until completion.

Contents:

• Project environment and setup
  • Environment and dependencies
  • Installation
• Getting started with Sphinx
  • Create a documentation folder
  • sphinx-quickstart
  • Build a basic html
• Deploy Sphinx documentation online
• Continuous integration with GitHub