logo

Sphinx Quick Start Guide

Contents:

  • Quick Start
  • WFRT Demo
  • Installation
  • Repo Setup
  • Build a Website
  • GitHub Pages
  • Sphinx Themes
  • Docstrings
  • Index / Toctree
  • Using autodocs
  • Markdown with Sphinx
  • Example Markdown
  • Math Equations
  • Jupyter Notebook
  • Useful resources
Theme by the Executable Book Project
  • .rst

Quick Start

Quick Start#

To run this demo, first start by forking and cloning the wfrt-demo.

A quick start guide showing:

  1. Fork and clone repo.

  2. How to Install Sphinx.

  3. How to set up your Repository.

  4. How to build a website.

  5. How to connect docs to GitHub Pages.

  6. How to add a theme to Sphinx.

  7. How to use docstring in Sphinx.

  8. How to use autodocs

  9. How to use Markdown with Sphinx.

previous

How to build documentation with Sphinx

next

WFRT Demo

By Christopher Rodell
© Copyright 2020, Christopher Rodell.