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 docs target #262

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

CMake docs target #262

wants to merge 2 commits into from

Conversation

mdavis36
Copy link
Collaborator

@mdavis36 mdavis36 commented Feb 6, 2024

Summary

  • This PR is a refactor
    • It changes the taget for building documentation from Spheral_docs to docs.

We are reassigning BLTs default target name for documentation as we aren't able to use their built in macro for Sphinx documentation with our python environment. This is mostly due to how BLT checks for "executable" variables like SPHINX_EXECUTABLE. Passing our Python env as a part of this variable would work but currently causes an error with the way BLT checks the validity of the executable.


ToDo :

  • Annotate RELEASE_NOTES.md with notable changes.
  • Create LLNLSpheral PR pointing at this branch. (PR#)
  • LLNLSpheral PR has passed all tests.

…provided documentation funciton will not work with the current BLT implementation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant