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

Add crosslinks and minor edits to docs #3

Merged
merged 4 commits into from
Nov 22, 2024

Conversation

gspetro-NOAA
Copy link

Description

  • This PR adds crosslinks and minor edits to docs. This way, you won't need to update image numbers each time you add or remove images. RTD will do it automatically.
    It also adds an empty references.bib file to eliminate a build warning about contrib-bibtex. (You can remove that file and the bibtex_bibfiles line in conf.py that references it, but you'll also have to remove contrib-bibtex from the list of extensions in that case.)

Type of change

  • Bug fix (fixes something broken)
  • New feature (adds functionality)
  • Maintenance (code refactor, clean-up, new CI test, etc.)

Change characteristics

  • Is this a breaking change (a change in existing functionality)? NO
  • Does this change require a documentation update? YES
  • Does this change require an update to any of the following submodules? NO

How has this been tested?

I built the docs locally and on ReadTheDocs. You can view the docs for my fork here (with functioning crosslinks): https://gsp-gwc.readthedocs.io/en/docs4csps/noaa_csp.html

Checklist

  • Any dependent changes have been merged and published
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have documented my code, including function, input, and output descriptions
  • My changes generate no new warnings
  • New and existing tests pass with my changes
  • This change is covered by an existing CI test or a new one has been added
  • Any new scripts have been added to the .github/CODEOWNERS file with owners
  • I have made corresponding changes to the system documentation if necessary

@weihuang-jedi weihuang-jedi merged commit 51cb1f3 into NOAA-EPIC:docs4csps Nov 22, 2024
5 checks passed
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.

2 participants