Simple Tutorial on How to document your Python Project using Sphinx

Step 1: Installing Sphinx

First,you need to install sphinx via pip.You should install the most recent version

$ pip install sphinx

sphinx

Step 2: Create folder

Create a directory and cd into this directory.

mkdir pythonsphinx
cd pythonsphinx

Step 3: Setup your Project with Quickstart

sphinx-quickstart
sphinx

Follow this configuration for now.

Step 4: Folder structure now look likes Below:

sphinx
sphinx

Step 5: Create the HTML

sphinx

Step 6: Now open the index.html

sphinx

More details about the themes:

https://sphinx-themes.org/

Leave a reply