Casttech Sphinx documentation setup:¶

step 1 : Folder setup:-

• create Projects folder
• create Casttech folder
• open terminal
• Change directory to Projects and again change directory to casttech folder
• Clone --> git clone devaraj@casttech.amachu.tech:/home/pms/repos/casttech-docs

step 2 : install python 3 --> sudo apt-get install python3-sphinx

step 3 : Enter the following commands:-

• Enter list command --> ls
• Change directory to --> casttech-docs
• Create a build directory using --> ** mkdir build**
• Change directory to --> source

step 4 : Install pwd sphinx Using this command --> sudo apt install pwdsphinx

step 5 : Run sphnix for confirmation of installation

step 6 : Install python-pip3 Using this command --> sudo apt install python3-pip

step 7 :

1. Install and activate vitual machine
2. Run pip install sphinxcontrib-video

step 8 : Install the sphinx theme using this command --> pip install sphinx-rtd-theme

step 9 : Build a sphinx and source using this command --> sphinx-build -M html source build

step 10 : Enter the following commands for finish the sphinx setup :-

1. Change directory to build --> cd build
2. list --> ls
3. change directory to html --> cd html
4. list --> ls
   1.To view the document in browser using this command --> google-chrome index.html

Finally complete the sphinx documentation visible in the google chrome with your local path and book mark it.