-
Notifications
You must be signed in to change notification settings - Fork 173
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
Initial support for documentation versions #4835
Conversation
isis/cmake/BuildDocs.cmake
Outdated
|
||
# Set up output directory and a temporary directory for building | ||
set(docVersion 7.0.0) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ignoring, but noting (for later reviews)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above, just set this to ${CMAKE_PROJECT_VERSION}
and do it prior to the message above so the message can just use ${docVersion}
isis/cmake/BuildDocs.cmake
Outdated
@@ -464,8 +472,10 @@ endfunction(build_object_docs) | |||
function(build_docs) | |||
|
|||
message("Building Isis Documentation...") | |||
message(" Version is: " ${VERSION}) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where is VERSION set?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
At the top of the second from the bottom function. It's hardcoded for now, but that will change today if all goes well
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use ${CMAKE_PROJECT_VERSION}
instead to get the version from ISIS.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
New setup seems reasonable to me. Are the changes in the doxyfiles important or just incoming changes for using a more up to date doxygen version?
isis/cmake/BuildDocs.cmake
Outdated
@@ -464,8 +472,10 @@ endfunction(build_object_docs) | |||
function(build_docs) | |||
|
|||
message("Building Isis Documentation...") | |||
message(" Version is: " ${VERSION}) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use ${CMAKE_PROJECT_VERSION}
instead to get the version from ISIS.
isis/cmake/BuildDocs.cmake
Outdated
|
||
# Set up output directory and a temporary directory for building | ||
set(docVersion 7.0.0) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above, just set this to ${CMAKE_PROJECT_VERSION}
and do it prior to the message above so the message can just use ${docVersion}
Many new doxygen versions cause us to do a doxygen -u to get rid of all the xyz is deprecated warning. This is not a functional difference, except that now we can see real errors without wading through all junk |
* Initial support for documentation versions * Remove hard coded version
* Initial support for documentation versions * Remove hard coded version
Add ability to get to multiple versions of the ISIS documentation
Description
Multiple versions of ISIS documentation can now live side-by-side. New versions will be placed in a dir named from the ISIS version.
Related Issue
Motivation and Context
There have been many requests for old version of the docs.
How Has This Been Tested?
This has been locally deployed and all of the pages hand tested
Screenshots (if appropriate):
Types of changes
Checklist:
Licensing
This project is mostly composed of free and unencumbered software released into the public domain, and we are unlikely to accept contributions that are not also released into the public domain. Somewhere near the top of each file should have these words: