https://github.com/isaitb/docs-guides
Documentation sources for the Test Bed's guides.
https://github.com/isaitb/docs-guides
Last synced: 26 days ago
JSON representation
Documentation sources for the Test Bed's guides.
- Host: GitHub
- URL: https://github.com/isaitb/docs-guides
- Owner: ISAITB
- Created: 2026-06-10T07:14:26.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2026-06-10T09:10:04.000Z (about 1 month ago)
- Last Synced: 2026-06-10T11:10:15.153Z (about 1 month ago)
- Language: Python
- Size: 44 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Documentation for ITB guides
The ITB guides are built using restructured text and Sphinx. The theme used is the RTD (Read The Docs theme).
## Installation
Installation process described at: http://www.sphinx-doc.org/en/master/usage/installation.html
### Step 1
Download and install python. On windows do this get the installer from https://www.python.org/downloads/ (currently version 3.* is used).
On Linux do:
```
apt-get update
apt-get install -y python-pip python-dev build-essential
```
### Step 2
Install Sphinx `pip install -U sphinx`
### Step 3
Verify installation with `sphinx-build --version`
### Step 4
Install RTD theme: `pip install sphinx_rtd_theme`.
This is then used as "sphinx_rtd_theme"
## Use
To generate the HTML documentation issue (from the current folder): `make html`. The output is stored in folder "build"
To fully cleanup the produced documentation: `make clean`.
## Licence
The sources in this repository are published under the [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) licence.