[develop]: Correct PDF-generated release version for develop docs#513
Merged
MichaelLueken merged 1 commit intoDec 14, 2022
Conversation
MichaelLueken
approved these changes
Dec 13, 2022
Collaborator
MichaelLueken
left a comment
There was a problem hiding this comment.
These changes are to change the name of the produced PDF file from v1.0 to develop. Approving this change.
panll
approved these changes
Dec 13, 2022
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
DESCRIPTION OF CHANGES:
Currently, when users generate a PDF of the documentation locally off of the develop branch, the PDF says "Release v1.0," but the content is up-to-date for the develop branch. This PR changes the "release" field in the
conf.pyfile to reflect that documentation is for thedevelopbranch, not v1.0.(Note that this problem does not affect the online RTD documentation.)
Type of change
TESTS CONDUCTED:
None required. I generated an updated PDF of the docs successfully.
DEPENDENCIES:
N/A
DOCUMENTATION:
N/A
ISSUE:
Partially resolved Issue #512 . PRs to the SRW v2.0.0 and v2.1.0 branches will complete the fix.
CHECKLIST
CONTRIBUTORS (optional):
Thanks to @ywangwof for noticing this bug on the v2.1.0 release branch!