Skip to content

Polished docs for documentation building #227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Polished docs for documentation building #227

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dfe8c46
Polished docs for documentation building
akharche Dec 16, 2020
a70110b
Remove not necessary dependency
akharche Dec 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ What?
Generator scripts for dpCtl API documentation. To run these scripts, follow
the following steps:

`mkdir build` <br/>
`cd build` <br/>
`cmake -DDPCTL_DOCGEN_PREFIX=<WHERE_YOU_WANT_DOCS_TO_BE_GENERATED>` <br/>
`make Sphinx` <br/>
```bash
mkdir build
cd build
cmake .. -DDPCTL_DOCGEN_PREFIX=<WHERE_YOU_WANT_DOCS_TO_BE_GENERATED>
make Sphinx
```

The `DPCTL_DOCGEN_PREFIX` flag is optional and can be omitted to generate the
documents in the current source directory in a sub-directory called
Expand All @@ -25,4 +27,4 @@ packages installed:
- sphinx
- doxygen
- breathe
- exhale
- exhale