Skip to content

Commit

Permalink
docs: Add more information about doxygen integration
Browse files Browse the repository at this point in the history
  • Loading branch information
samjwu committed Feb 12, 2024
1 parent 8ca0fee commit ffc1f84
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/user_guide/doxygen_integration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# Doxygen Integration

## What

`doxysphinx` is a package that handles integration
of `Doxygen` and `Sphinx` documentation.

`doxysphinx` allows displaying `Doxygen` documentation in the `Sphinx` documentation.

`rocm-docs-core` applies some additional formatting and styling on top of this
to stay in line with our themes.

Since doxysphinx automatically integrates the Doxygen documentation,
developers only have to update the documentation strings in the source code
if they are formatted for Doxygen.

## How

Assuming Doxygen documentation is already configured correctly,
call the `run_doxygen` method in the configuration file (`conf.py`)
located in the `docs` folder.
Expand Down

0 comments on commit ffc1f84

Please sign in to comment.