File size: 1,880 Bytes
406662d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 | # Building Documentation
We use [Sphinx](https://www.sphinx-doc.org/en/master/) with the [Book Theme](https://sphinx-book-theme.readthedocs.io/en/stable/) for maintaining and generating our documentation.
> **Note:** To avoid dependency conflicts, we strongly recommend using a Python virtual environment to isolate the required dependencies from your system's global Python environment.
## Current-Version Documentation
This section describes how to build the documentation for the current version of the project.
<details open>
<summary><strong>Linux</strong></summary>
```bash
# 1. Navigate to the docs directory and install dependencies
cd docs
pip install -r requirements.txt
# 2. Build the current documentation
make current-docs
# 3. Open the current docs
xdg-open _build/current/index.html
```
</details>
<details> <summary><strong>Windows</strong></summary>
```batch
:: 1. Navigate to the docs directory and install dependencies
cd docs
pip install -r requirements.txt
:: 2. Build the current documentation
make current-docs
:: 3. Open the current docs
start _build\current\index.html
```
</details>
## Multi-Version Documentation
This section describes how to build the multi-version documentation, which includes previous tags and the main branch.
<details open> <summary><strong>Linux</strong></summary>
```bash
# 1. Navigate to the docs directory and install dependencies
cd docs
pip install -r requirements.txt
# 2. Build the multi-version documentation
make multi-docs
# 3. Open the multi-version docs
xdg-open _build/index.html
```
</details>
<details> <summary><strong>Windows</strong></summary>
```batch
:: 1. Navigate to the docs directory and install dependencies
cd docs
pip install -r requirements.txt
:: 2. Build the multi-version documentation
make multi-docs
:: 3. Open the multi-version docs
start _build\index.html
```
</details>
|