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

Bugfix/upcoming readthedocs deprecation fixes #171

Merged

Conversation

scrasmussen
Copy link
Member

TYPE: bug fix, enhancement

KEYWORDS: documentation, readthedocs, MkDocs

SOURCE: Soren Rasmussen, NCAR

DESCRIPTION OF CHANGES:

  • meets upcoming readthedocs deprecations
    • readthedocs requirement for a version 2 .readthedocs.yaml file.
    • Uses build.os instead of build.image in .readthedocs.yaml
  • better organization and fixes to MkDocs yaml. Note, it will probably look differently after being merged but built locally it looked like the following:
image
  • Changing readthedocs link to 'latest', which points to the main branch, since that is where the current fixes are being committed. It was pointing to the develop branch's 'develop' url.
  • A few documentation formatting changes and link additions
  • Google analytics method has changed, commenting out for now

TESTS CONDUCTED: built locally

Checklist

  • Closes issue #xxxx (An issue must exist or be created to be closed. The
    issue describes and documents the problem and general solution, the PR
    describes the technical details of the solution.)
  • Tests added (unit tests and/or regression/integration tests)
  • Backwards compatible
  • Requires new files? If so, how to generate them.
  • Fully documented

 - meets readthedocs' upcoming requirement for a version 2 .readthedocs.yaml file.
 - Use build.os instead of build.image in .readthedocs.yaml
…eprecated method for doing google analytics. Small formatting changes if markdown files
…being edited, changing the readthedocs link to the 'latest' for right now. The 'latest' url is built from the main branch
@gutmann gutmann merged commit c2df2cd into NCAR:main Sep 5, 2023
1 check 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