Skip to content

Playground / reference for creating documentation with Sphinx

Notifications You must be signed in to change notification settings

squidmin/sphinx-template

Repository files navigation

sphinx-template

Sphinx can be used to create general documentation, not just for Python modules. It supports reStructuredText (reST) and Markdown, making it a versatile tool for documentation.

This repo is a playground / reference for creating documentation with Sphinx.

Download dependencies

Install pandoc for .md to .rst file conversion

Install pandoc via Homebrew if you haven't done so already:

brew install pandoc

Install other dependencies

pip3 install -r requirements.txt

Optional: Initialize Sphinx Project

If a Sphinx project hasn't been initialized, run the command:

sphinx-quickstart

Build documentation

sphinx-build -b html . _build

Clean the build directory and re-build

make clean
sphinx-build -b html . _build

View built documentation

Open the index.html file located in the _build directory.