Getting Started with Sphinx
This post introduces the step-by-step guide to easily auto-generate clean and well-organized documentation from Python code using Sphinx.
- Install Sphinx
You can install Sphinx using pip
pip install -U Sphinx
Or click and follow the official documentation.
- Initialize the Sphinx Configuration
In the root directory of your project, run the following command to initialize the sphinx source directory and create a default configuration:
sphinx-quickstart
Fill out the basic configuration properties.
- Update the conf.py File
Date: August 26, 2022
Tags:
Programming
Python