🛠️ Installation¶
Clone the Repository
git clone https://github.com/Auromix/sphinx_tutorial.git cd sphinx_tutorial
Install Sphinx
Install Sphinx and necessary dependencies:
# Install Sphinx pip install -U sphinx
Install the required themes:
# Install Material Sphinx theme pip install git+https://github.com/bashtage/sphinx-material.git # Install sphinxawesome-theme pip install sphinxawesome-theme
Build the Documentation
To generate the HTML files for this repository, navigate to the docs directory and run the following command:
cd docs make html
To view the generated documentation, use:
xdg-open build/html/index.html
For specific usage details and syntax demonstrations, refer to the individual .rst files in the docs directory.