blob: cbe951ba41d424f3d66462283cd4d735e48635b7 (
plain)
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
|
# Low level CAN signaling binder
Low level CAN bus binder, based upon OpenXC vi-firmware project.
Full document can be found under `docs` directory.
# Generate documentation
## Prerequisites
You can use gitbook to serve documentation. To do so, please install it using *npm* as well as *calibre* package from your package distribution manager:
```bash
sudo npm install -g gitbook-cli
sudo apt-get install calibre
```
To generate Doxygen documentation, you'll need doxygen and graphviz:
```bash
sudo apt-get install doxygen graphviz
```
Prepare your build environment:
```bash
mkdir build && cd build
cmake ..
```
## Generation
Generate a PDF version :
```bash
gendocs.sh pdf
```
Serve an HTML version, this will run a web server that will serve you locally documentation :
```bash
gendocs.sh serve
```
Generate doxygen documentation:
```bash
gendocs.sh doxygen
```
or
```bash
cd build && make doxygen
```
|
