"git@developer.sourcefind.cn:gaoqiong/migraphx.git" did not exist on "ec9e35c10536dd02ce55e973ae2c26730d5aebd7"
Commit 3ef07c55 authored by Paul's avatar Paul
Browse files

Fix location of documentation info

parent 803eb3ce
...@@ -71,6 +71,12 @@ The tests can be run by using the 'check' target: ...@@ -71,6 +71,12 @@ The tests can be run by using the 'check' target:
` cmake --build . --config Release --target check ` **OR** ` make check ` ` cmake --build . --config Release --target check ` **OR** ` make check `
## Building the documentation
HTML and PDF documentation can be built using:
`cmake --build . --config Release --target doc` **OR** `make doc`
This will build a local searchable web site inside the doc/html folder. This will build a local searchable web site inside the doc/html folder.
Documentation is built using [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html), [Sphinx](http://www.sphinx-doc.org/en/stable/index.html), and [Breathe](https://breathe.readthedocs.io/en/latest/) Documentation is built using [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html), [Sphinx](http://www.sphinx-doc.org/en/stable/index.html), and [Breathe](https://breathe.readthedocs.io/en/latest/)
...@@ -81,14 +87,6 @@ Requirements for both Sphinx and Breathe can be installed with: ...@@ -81,14 +87,6 @@ Requirements for both Sphinx and Breathe can be installed with:
Depending on your setup `sudo` may be required for the pip install. Depending on your setup `sudo` may be required for the pip install.
## Building the documentation
HTML and PDF documentation can be built using:
`cmake --build . --config Release --target doc` **OR** `make doc`
The generated documentation will be located in `doc/doxygen/`.
## Formatting the code ## Formatting the code
All the code is formatted using clang-format. To format a file, use: All the code is formatted using clang-format. To format a file, use:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment