Contribute to Documentation#
This guide outlines the process for contributing to our documentation.
Prerequisites#
Setup Steps#
Clone the repository:
git clone https://github.com/upsidedownlabs/upsidedownlabs.github.io.git
Navigate to the cloned directory:
cd upsidedownlabs.github.io
Creating virtual environment
Windows:
py -m venv myenv myenv\Scripts\activate
Linux:
python3 -m venv myenv source myenv/bin/activate
Install dependencies:
pip install -r requirements.txt
For Windiows#
Install Python from the official website if not already installed.
Build the documentation:
sphinx-autobuild <source-dir> <output-dir>
Warning
The source directory and output directory must be different.
Example:
sphinx-autobuild . ../build/html
Note
Run this command if recent updates are not visible, this will clean the cache memory and rebuild the documentation.
.\make.bat clean
Linux-Specific Steps#
Ensure Python is installed.
Build the documentation:
make livehtml
Making Changes#
Locate the relevant
.rst
files in the repository.Make your desired edits.
Save the files to see live changes on your local server.
Note
Run this command if recent updates are not visible, this will clean the cache memory and rebuild the documentation.
make clean