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.

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

CMake: Build documentation #2300

Merged
merged 6 commits into from
May 7, 2021
Merged

CMake: Build documentation #2300

merged 6 commits into from
May 7, 2021

Conversation

ZedThree
Copy link
Member

@ZedThree ZedThree commented May 4, 2021

Resolves #1937

Pretty bare bones. There's a more complete method described in https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/

Currently we always run doxygen (via subprocess.call in conf.py), a nicer method would be to only run it when needed, which the above link describes how to do.

@ZedThree ZedThree added the build-system issues with make/configure/... label May 4, 2021
@ZedThree ZedThree added this to the BOUT-5.0 milestone May 4, 2021
CMakeLists.txt Outdated Show resolved Hide resolved
CMakeLists.txt Outdated Show resolved Hide resolved
manual/CMakeLists.txt Outdated Show resolved Hide resolved
@ZedThree ZedThree merged commit 6f371d7 into next May 7, 2021
@ZedThree ZedThree deleted the cmake-build-docs branch May 7, 2021 08:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build-system issues with make/configure/...
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants