Project

General

Profile

Actions

Task #389

open

Sphinx documentation setup

Added by Amul Munusamy about 2 months ago. Updated about 2 months ago.

Status:
Resolved
Priority:
Normal
Start date:
06/18/2026
Due date:
% Done:

0%

Estimated time:
1:00 h
Spent time:

Description

To set up Sphinx documentation

Reference: #305 or #306

Sphinx documentation learning resources:

https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html


Files

git_clone.png (141 KB) git_clone.png Venkatesan Mani, 06/20/2026 01:07 PM
python_3_install2.png (133 KB) python_3_install2.png Venkatesan Mani, 06/20/2026 01:09 PM
sphnix_install4.png (158 KB) sphnix_install4.png Venkatesan Mani, 06/20/2026 01:11 PM
run_sphnix5.png (63.2 KB) run_sphnix5.png Venkatesan Mani, 06/20/2026 01:12 PM
install_pip.png (174 KB) install_pip.png Venkatesan Mani, 06/20/2026 01:15 PM
install_theme7.png (152 KB) install_theme7.png Venkatesan Mani, 06/20/2026 01:17 PM
Actions #1

Updated by Amul Munusamy about 2 months ago

  • Description updated (diff)

Updated by Venkatesan Mani about 2 months ago

Actions #3

Updated by Venkatesan Mani about 2 months ago

  • Status changed from In Progress to Resolved

Sphinx documentation setup

** Step-1: Open the terminal.Then make the folder.Using these commands.**

** Step-2: install python 3 ( sudo apt-get install python3-sphinx) **

** Step-3: Install pwd sphinx **

** Step-4: Run sphinx. **

**Step-5:Install python(pip3) **

** Step-6: Install sphinx theme **

Actions

Also available in: Atom PDF