We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 574376e commit 19760efCopy full SHA for 19760ef
docs/README.md
@@ -3,11 +3,13 @@ What?
3
4
Generator scripts for dpCtl API documentation. To run these scripts, follow
5
the following steps:
6
-
7
-`mkdir build` <br/>
8
-`cd build` <br/>
9
-`cmake -DDPCTL_DOCGEN_PREFIX=<WHERE_YOU_WANT_DOCS_TO_BE_GENERATED>` <br/>
10
-`make Sphinx` <br/>
+```bash
+cd dpctl/docs
+mkdir build
+cd build
+cmake -DDPCTL_DOCGEN_PREFIX=<WHERE_YOU_WANT_DOCS_TO_BE_GENERATED> ..
11
+make Sphinx
12
+```
13
14
The `DPCTL_DOCGEN_PREFIX` flag is optional and can be omitted to generate the
15
documents in the current source directory in a sub-directory called
@@ -25,4 +27,4 @@ packages installed:
25
27
- sphinx
26
28
- doxygen
29
- breathe
-- exhale
30
+- exhale
0 commit comments