README.md 1.28 KB
Newer Older
1
# Sight-doc
2

3
## Description
4

5
6
7
8
This repository contains the documentation of Sight.
The main repository is available [here](https://git.ircad.fr/Sight/sight).

## Building the documentation with Linux/MacOS
9
10
11
12
13

In order to build this documentation, you will need to install Sphinx (especially the sphinx-build command).
The documentation for installation is available [here](http://www.sphinx-doc.org/en/stable/install.html).

Once sphinx is installed, launch the following command at the root of your local copy to generate html documentation:
14
15

```bash
16
17
18
19
make html
```

Other generation backends can be listed with the `make` command.
20

21
## Building the documentation with Windows
22
23

In order to build this documentation, you will need to install Sphinx (especially the sphinx-build command).
24
First, you need to install [Python](https://www.python.org/downloads/)
25

26
- Add Python to your PATH
27
28

```bash
29
30
SET PATH=%PATH%;C:\Python
```
31

32
- Add Python Script
33
34

```bash
35
36
SET PATH=%PATH%;C:\Python\Scripts
```
37

38
- Use pip to install Sphinx
39
40

```bash
41
42
pip install sphinx
```
43

44
- Use pip to install Sphinx rtd-theme sphinx-tabs
45
46

```bash
47
pip install sphinx_rtd_theme sphinx-tabs
48
```
49
50

Once sphinx is installed, launch the following command at the root of your local copy to generate html documentation:
51
52

```bash
53
sphinx-build . _build\html
54
```