Skip to content

Instantly share code, notes, and snippets.

View dwai1714's full-sized avatar
😀

DC dwai1714

😀
View GitHub Profile
@GLMeece
GLMeece / Sphinx_Setup_for_autodoc.md
Last active November 29, 2023 14:22
Setting up Sphinx for generating documentation from DocStrings, leveraging the Napoleon extension.

Sphinx Setup for autodoc

Sphinx is a documentation generator that is the de facto standard for Python projects. The official documentation can be a bit daunting as it includes so many options, it's hard to know where to start.

Note: This Gist was updated on 04/04/2019 to accomodate a newer version of Sphinx, as well as Python 3.7. YMMV!

This document is written with the following presuppositions: