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]: Update doc requirements and add logo #1018

Merged
merged 21 commits into from
Feb 21, 2024

Conversation

gspetro-NOAA
Copy link
Collaborator

@gspetro-NOAA gspetro-NOAA commented Feb 13, 2024

DESCRIPTION OF CHANGES:

  • Specify a minimum version of Sphinx in requirements.in
  • Update requirements.txt based on requirements.in for a full list of dependencies. This will ensure uniform documentation builds across platforms.
  • Add UFS logo to documentation.
  • Rename docs directory to doc for NCO compliance.
  • Slightly darken blue sidebar background to meet WCAG AA text/background contrast standards for large text.

NOTE: Most file changes are just a rename. Changes that need reviewing appear in: conf.py, requirements.txt, conf.py, .readthedocs.yaml, and theme_overrides.css

Type of change

  • This change requires a documentation update

TESTS CONDUCTED:

None required. Documentation for PR can be viewed at the bottom of the PR.

DEPENDENCIES:

Merge PR #1014 first.

DOCUMENTATION:

All documentation.

ISSUE:

Resolves Issue #1017 .

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
  • 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

CONTRIBUTORS (optional):

@MichaelLueken MichaelLueken linked an issue Feb 14, 2024 that may be closed by this pull request
@gspetro-NOAA gspetro-NOAA changed the title Text/rtd update [develop]: Update doc requirements and add logo Feb 14, 2024
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.

@gspetro-NOAA - These changes look good to me! The new logo in RTD looks good and the modification to the background color really makes it pop!

It looks like there is a conflict with the ConfigWorkflow.rst following the latest merge. At your earliest convenience, please merge the latest HEAD into your text/rtd-update branch and I will be able to merge this back to develop. Thanks!

@MichaelLueken MichaelLueken merged commit 6d3ebfb into ufs-community:develop Feb 21, 2024
2 checks passed
@gspetro-NOAA gspetro-NOAA deleted the text/rtd-update branch September 26, 2024 20:56
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.

Update RTD dependencies
3 participants