blob: 6828e7504cdbb54d9e819fb74ab2984e600a1a54 (
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
54
55
56
57
|
===========================
Building the developer docs
===========================
For user and admin docs, go to the directory `doc/docbkx`.
Dependencies
============
You'll need to install python *Sphinx* package and *oslosphinx*
package:
::
sudo pip install sphinx oslosphinx
If you are using the virtualenv you'll need to install them in the
virtualenv.
Get Help
========
Just type make to get help:
::
make
It will list available build targets.
Build Doc
=========
To build the man pages:
::
make man
To build the developer documentation as HTML:
::
make html
Type *make* for more formats.
Test Doc
========
If you modify doc files, you can type:
::
make doctest
to check whether the format has problem.
|