https://github.com/isaitb/docs-itb-ca
Documentation sources for the Test Bed's user guide (community administrator).
https://github.com/isaitb/docs-itb-ca
Last synced: 26 days ago
JSON representation
Documentation sources for the Test Bed's user guide (community administrator).
- Host: GitHub
- URL: https://github.com/isaitb/docs-itb-ca
- Owner: ISAITB
- Created: 2026-06-10T07:25:48.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2026-06-12T13:19:21.000Z (about 1 month ago)
- Last Synced: 2026-06-12T15:05:12.550Z (about 1 month ago)
- Language: Python
- Size: 76.4 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Documentation for GITB software user guide
The GITB software user guide is built using restructured text and Sphinx. The theme used is the RTD (Read The Docs theme).
The current documentation refers to the perspective of an **Community Administrator**.
## 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.