Contribute to Documentation

This guide outlines the process for contributing to our documentation.

Prerequisites

• Python
• Git

Setup Steps

1. Clone the repository:

   git clone https://github.com/upsidedownlabs/upsidedownlabs.github.io.git
   

2. Navigate to the cloned directory:

   cd upsidedownlabs.github.io
   

3. Creating virtual environment

   • Windows:

   py -m venv myenv
   myenv\Scripts\activate
   

   • Linux:

   python3 -m venv myenv
   source myenv/bin/activate
   

4. Install dependencies:

   pip install -r requirements.txt
   

For Windiows

1. Install Python from the official website if not already installed.

2. 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

1. Ensure Python is installed.

2. Build the documentation:

   make livehtml
   

Making Changes

1. Locate the relevant .rst files in the repository.

2. Make your desired edits.

3. 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