Skip to content

Commit 19760ef

Browse files
Update docs generation instruction (#226)
* Improve README instructions to build docs. Co-authored-by: Sergey Pokhodenko <sergey.pokhodenko@intel.com>
1 parent 574376e commit 19760ef

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

docs/README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@ What?
33

44
Generator scripts for dpCtl API documentation. To run these scripts, follow
55
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/>
6+
```bash
7+
cd dpctl/docs
8+
mkdir build
9+
cd build
10+
cmake -DDPCTL_DOCGEN_PREFIX=<WHERE_YOU_WANT_DOCS_TO_BE_GENERATED> ..
11+
make Sphinx
12+
```
1113

1214
The `DPCTL_DOCGEN_PREFIX` flag is optional and can be omitted to generate the
1315
documents in the current source directory in a sub-directory called
@@ -25,4 +27,4 @@ packages installed:
2527
- sphinx
2628
- doxygen
2729
- breathe
28-
- exhale
30+
- exhale

0 commit comments

Comments
 (0)