Skip to content

Instantly share code, notes, and snippets.

@mlindsk
mlindsk / sphinx-documentation.md
Created August 3, 2023 08:58 — forked from rinaldo-rex/sphinx-documentation.md
Sphinx documentation cheatsheet

Overview

This document is a simple resource to create sphinx documentation for projects with python(or not). This isn't exhaustive, but it'll help us get started without much hassle, (which, is typical for sphinx generated documenting)

Prerequisites

For better results, ensure that you're inside a virtual env. This document assumes you're in a Pipenv based environment. Update it later to include other python package management tools (hopefully poetry)