@@ -32,58 +32,13 @@ sudo apt-get install liblua5.2-dev
32
32
Generating the docs
33
33
===================
34
34
35
- The documentation should be generated using the provided ` Cmake ` build script.
36
- There are a few configurable options that can be used to select the type of
37
- documentation to generate .
35
+ The helper script `` scripts/gen_docs.py `` is the preferred way to generate the
36
+ documentation. The generated documentation html pages will be installed to the
37
+ `` CMAKE_INSTALL_PREFIX/docs `` directory .
38
38
39
- Build only Doxygen for C API
40
39
----------------------------
41
40
``` bash
42
- cd dpctl/docs
43
- mkdir -p build
44
- cd build
45
- cmake ..
46
- make Doxygen
41
+ python scripts/gen_docs.py --doxyrest-root=< PATH to Doxyrest installation>
47
42
```
48
- The above steps will generate the ` Doxygen ` files at
49
- ` dpctl/docs/generated_docs/doxygen/html ` . The documentation can also be
50
- generated at a custom location by providing the optional flag
51
-
52
- ``` bash
53
- cd dpctl/docs
54
- mkdir -p build
55
- cd build
56
- cmake .. -DDPCTL_DOCGEN_PREFIX=< WHERE_YOU_WANT_DOCS_TO_BE_GENERATED>
57
- make Doxygen
58
- ```
59
-
60
- Build only Sphinx for Python API
61
- --------------------------------
62
- ``` bash
63
- cd dpctl/docs
64
- mkdir -p build
65
- cd build
66
- cmake .. -DDPCTL_DOCGEN_PREFIX=< WHERE_YOU_WANT_DOCS_TO_BE_GENERATED>
67
- make Sphinx
68
- ```
69
-
70
- The ` make Sphinx ` command will generate only the Python API docs for dpctl.
71
-
72
- Build consolidated docs
73
- -----------------------
74
- It is possible to generate a single site with both Python and C API docs. As
75
- mentioned before, ` Doxyrest ` and ` Lua ` are required to generate the consolidated
76
- site.
77
-
78
- ``` bash
79
- cd dpctl/docs
80
- mkdir -p build
81
- cd build
82
- cmake .. \
83
- -DDPCTL_ENABLE_DOXYREST=ON \
84
- -DDoxyrest_DIR=< PATH_TO_DOXYREST_INSTALL_DIR> \
85
- -DDPCTL_DOCGEN_PREFIX=< WHERE_YOU_WANT_DOCS_TO_BE_GENERATED>
86
- make Sphinx
87
- ```
88
- The ` Doxyrest_DIR ` flag is optional, but is needed when Doxyrest is installed in
89
- a non-system location.
43
+ To skip generating the documentation for `` libsyclinterface `` , the
44
+ `` --doxyrest-root `` option should be omitted.
0 commit comments