1. Sphinx

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation using reStructuredText .

1.1. Sphinx Resources

Resources to Learn Sphinx.

• Sphinx

• Read the Docs - Getting started with Sphinx

• Sphinx with github webpage

• Youtube

1.2. Installation

Ubuntu/Linux

apt-get install python3-sphinx

To get latest version, it is advisable to use python virtual environment as follows

sudo apt install -y python3-venv
cd ~
mkdir Virt_Env
cd Virt_Env/
python3 -m venv sphinx
source sphinx/bin/activate
pip install -U sphinx
sudo gedit alias VSphinx='source ~/Virt_Env/sphinx/bin/activate'
//set alias & from next time use 'VSphinx' to activate virtual environment- 'deactivate' to exit.//
deactivate

1.3. Getting Started

sphinx-quickstart

Just answer to project name and author, keep rest to default or unanswered.

1.4. HTML Output

make html

Open “_build/html/index.html” in chrome or firefox to view output.

1.5. Theme

Detailed Information is available here

To change default theme, edit conf.py and change to different available theme.

html_theme = 'alabaster' # classic/sphinxdoc/scrolls/agogo