Skip to content
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

Jump to bottom

[DOC] Add doxygen builds to morpheus #272

Closed
dagardner-nv opened this issue Jul 13, 2022 · 0 comments · Fixed by #414
Closed

[DOC] Add doxygen builds to morpheus #272

dagardner-nv opened this issue Jul 13, 2022 · 0 comments · Fixed by #414
Assignees
@dagardner-nv
Labels
doc Improvements or additions to documentation

Comments

@dagardner-nv
Copy link
Contributor

Report incorrect documentation

We have docstrings for the C++ code, but are not building it.
@dagardner-nv dagardner-nv added doc Improvements or additions to documentation Needs Triage Need team to review and classify labels Jul 13, 2022
@dagardner-nv dagardner-nv self-assigned this Oct 24, 2022
@dagardner-nv dagardner-nv mentioned this issue Oct 25, 2022
Merged
@jarmak-nv jarmak-nv removed the Needs Triage Need team to review and classify label Nov 4, 2022
@ghost ghost closed this as completed in #414 Dec 7, 2022
ghost pushed a commit that referenced this issue Dec 7, 2022
@dagardner-nv
Add C++ API docs to documentation builds (#414)
1538ef6 
- Sphinx documentation builds are now a cmake target
- exhale & breathe extensions integrate doxygen generated output into Sphinx docs
- Marking this as breaking since this PR changes the way the documentation is built

New documentation procedure is:

1. Configure cmake with: `MORPHEUS_BUILD_DOCS=ON`
1. `cmake --build build --target morpheus_docs`


Closes #272

Authors:
  - David Gardner (https://github.com/dagardner-nv)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)

URL: #414
@ghost ghost moved this to Done in Morpheus Boards Dec 7, 2022
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dagardner-nv dagardner-nv

Labels
doc Improvements or additions to documentation
Projects
Morpheus Boards
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add C++ API docs to documentation builds dagardner-nv/Morpheus
2 participants
@dagardner-nv @jarmak-nv