File: README.md

package info (click to toggle)
onetbb 2022.3.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 19,440 kB
  • sloc: cpp: 129,228; ansic: 9,745; python: 808; xml: 183; objc: 176; makefile: 66; sh: 66; awk: 41; javascript: 37
file content (34 lines) | stat: -rw-r--r-- 647 bytes parent folder | download | duplicates (3)
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
# How to build oneTBB documentation

Our documentation is written in restructured text markup (.rst) and built using [Sphinx](http://www.sphinx-doc.org/en/master/). 

This document explains how to build oneTBB documentation locally. 

## Prerequisites
- Python 3.7.0 or higher
- Sphinx 

## Build documentation

Do the following to generate HTML output of the documentation: 

1. Clone oneTBB repository:

```
git clone https://github.com/uxlfoundation/oneTBB.git
```

2. Go to the `doc` folder:

```
cd oneTBB/doc
```

3. Run in the command line:

```
make html
```


That's it! Your built documentation is located in the ``build/html`` folder.