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

Add C++ API docs to documentation builds #414

Merged
29 commits merged into from
Dec 7, 2022
Merged

Add C++ API docs to documentation builds #414

29 commits merged into from
Dec 7, 2022

Conversation

dagardner-nv
Copy link
Contributor

@dagardner-nv dagardner-nv commented Oct 25, 2022 •
edited
Loading

  • 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
  2. cmake --build build --target morpheus_docs

Closes #272

@dagardner-nv dagardner-nv added breaking Breaking change doc Improvements or additions to documentation 0 - Blocked labels Oct 25, 2022
@dagardner-nv dagardner-nv requested review from a team as code owners October 25, 2022 19:23
@dagardner-nv dagardner-nv mentioned this pull request Oct 25, 2022
Closed
mdemoret-nv
mdemoret-nv approved these changes Oct 28, 2022
View reviewed changes
Copy link
Contributor

@mdemoret-nv mdemoret-nv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. What is breathe and exhale?

@mdemoret-nv
Copy link
Contributor

@dagardner-nv Is this still blocked?

@mdemoret-nv mdemoret-nv changed the base branch from branch-22.11 to branch-23.01 November 18, 2022 23:00
@mdemoret-nv
Copy link
Contributor

Pushing to 23.01

mdemoret-nv
mdemoret-nv reviewed Nov 19, 2022
View reviewed changes
docs/conda_docs.yml Outdated Show resolved Hide resolved
@mdemoret-nv
Copy link
Contributor

SWIPAT is approved. Merging.

@mdemoret-nv
Copy link
Contributor

@gpucibot merge

@ghost ghost merged commit 1538ef6 into nv-morpheus:branch-23.01 Dec 7, 2022
@dagardner-nv dagardner-nv deleted the david-doxygen-pt2 branch November 7, 2024 17:48
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bsuryadevara bsuryadevara Awaiting requested review from bsuryadevara

@mdemoret-nv mdemoret-nv Awaiting requested review from mdemoret-nv

Assignees
No one assigned
Labels
breaking Breaking change doc Improvements or additions to documentation
Projects
Morpheus Boards
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOC] Add doxygen builds to morpheus
2 participants
@dagardner-nv @mdemoret-nv