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

Initial support for documentation versions #4835

Merged
merged 2 commits into from
Mar 14, 2022

Conversation

scsides
Copy link
Contributor

@scsides scsides commented Mar 10, 2022

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Documentation change (update to the documentation; no code change)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have read and agree to abide by the Code of Conduct
  • I have read the CONTRIBUTING document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have added myself to the .zenodo.json document.
  • I have added any user impacting changes to the CHANGELOG.md document.

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:

This work is free and unencumbered software released into the public domain. In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain.

  • I dedicate any and all copyright interest in this software to the public domain. I make this dedication for the benefit of the public at large and to the detriment of my heirs and successors. I intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.


# Set up output directory and a temporary directory for building
set(docVersion 7.0.0)
Copy link
Contributor

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)

Copy link
Contributor

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}

@@ -464,8 +472,10 @@ endfunction(build_object_docs)
function(build_docs)

message("Building Isis Documentation...")
message(" Version is: " ${VERSION})
Copy link
Contributor

@ladoramkershner ladoramkershner Mar 10, 2022

Choose a reason for hiding this comment

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

Where is VERSION set?

Copy link
Contributor Author

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

Copy link
Contributor

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.

@scsides scsides requested a review from jessemapel March 10, 2022 23:52
Copy link
Contributor

@jessemapel jessemapel left a 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?

@@ -464,8 +472,10 @@ endfunction(build_object_docs)
function(build_docs)

message("Building Isis Documentation...")
message(" Version is: " ${VERSION})
Copy link
Contributor

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.


# Set up output directory and a temporary directory for building
set(docVersion 7.0.0)
Copy link
Contributor

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}

@scsides
Copy link
Contributor Author

scsides commented Mar 14, 2022

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

@ladoramkershner ladoramkershner merged commit 038993c into DOI-USGS:dev Mar 14, 2022
jessemapel pushed a commit to jessemapel/ISIS3 that referenced this pull request Apr 14, 2022
* Initial support for documentation versions

* Remove hard coded version
jessemapel pushed a commit that referenced this pull request Apr 14, 2022
* Initial support for documentation versions

* Remove hard coded version
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.

3 participants