Sphinx documentation setup¶

Step-1: Create folders and open that using:¶

• Making directory by

     mkdir Projects/Prashanti/prashanti_docs/
  

• Changing directory by

     cd Projects/Prashanti/prashanti_docs/
  

Step-2: Updating and Installing required packages:¶

• Updating the package list from repositories by

     sudo apt update
  

• Installing Sphinx documentation generator for Python by

     sudo apt-get install python3-sphinx
  

• Install the Sphinx extension for embedding videos in documentation by

     pip install sphinxcontrib-video
  

• Install sphinxcontrib-video, allowing it to override system package protections (forces installation even if it might conflict with system-managed packages):

     pip install sphinxcontrib-video --break-system-package
  

• Install the Read the Docs theme for Sphinx using Python 3, forcing installation even if it might conflict with system-managed packages:

     pip3 install sphinx-rtd-theme --break-system-packages
  

• Installing pip, the Python package installer by

     sudo apt-get install pip
  

• Installing Git, the version control system by

     sudo apt install git
  

• Installs the package pwdsphinx from the system repositories:

     sudo apt install pwdsphinx
  

Step-3: To copy the repository from the remote server to the local machine.¶

• Cloning the repository

     git clone monish@prashantipms.amachu.tech:/home/prashantipms/repos/prashanti_docs
  

Step-4: Ensuring build folder is available or not by¶

• list, making folder, opening source folder, list, back to current folder.

  ls
  mkdir build
  cd source/
  ls
  cd ..
  

Step-5: To create HTML, PDF, or other formats from reStructuredText(.rst) files.¶

• A Python documentation generator:

  sphinx
  

• Builds the HTML version of the documentation from the source directory into the build directory:

  sphinx-build -M html source build
  

• open build folder, list, again go to html folder, Opens the file index.html in Google Chrome.

  cd build/
  ls
  cd html
  google-chrome index.html
  

• Prashanti ERP Documentation: