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

[develop]: Correct PDF-generated release version for develop docs #513

Merged
merged 1 commit into from
Dec 14, 2022
Merged

[develop]: Correct PDF-generated release version for develop docs #513

merged 1 commit into from
Dec 14, 2022

Conversation

gspetro-NOAA
Copy link
Collaborator

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.py file to reflect that documentation is for the develop branch, not v1.0.

(Note that this problem does not affect the online RTD documentation.)

Type of change

  • Bug fix (non-breaking change which fixes an issue)

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

  • My code follows the style guidelines in the Contributor's Guide
  • I have performed a self-review of my own code using the Code Reviewer's Guide
  • I have commented my code, particularly in hard-to-understand areas N/A
  • My changes need updates to the documentation. I have made corresponding changes to the documentation
  • My changes do not require updates to the documentation (explain). N/A
  • My changes generate no new warnings
  • New and existing tests pass with my changes N/A
  • Any dependent changes have been merged and published N/A

CONTRIBUTORS (optional):

Thanks to @ywangwof for noticing this bug on the v2.1.0 release branch!

@gspetro-NOAA gspetro-NOAA changed the title [develop]: Correct PDF-generated release version for docs [develop]: Correct PDF-generated release version for develop docs Dec 12, 2022
Copy link
Collaborator

@MichaelLueken MichaelLueken left a comment

Choose a reason for hiding this comment

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

These changes are to change the name of the produced PDF file from v1.0 to develop. Approving this change.

@MichaelLueken MichaelLueken merged commit 0c8843f into ufs-community:develop Dec 14, 2022
@gspetro-NOAA gspetro-NOAA deleted the text/developpdf branch December 22, 2022 02:53
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.

4 participants