Skip to content

Remove duplicated list of observation converters#1067

Open
hkershaw-brown wants to merge 4 commits intomainfrom
undup-doc-obs-conv
Open

Remove duplicated list of observation converters#1067
hkershaw-brown wants to merge 4 commits intomainfrom
undup-doc-obs-conv

Conversation

@hkershaw-brown
Copy link
Member

Description:

This pull request

  • adds anchors to the observation converter readmes, uses these instead of relative paths to link.
  • Removes the duplicate (but never in sync) list of available observation converters
  • Adds a section for 'synthetic observations' because this is referenced a couple of times with in docs.
  • Corrects a couple of spelling mistakes

Fixes issue

Fixes #998

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Documentation changes needed?

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.

Tests

Please describe any tests you ran to verify your changes.

Built documentation locally, checked for broken links in the converter rsts. (Note there are a lot of broken links in dart because of the ../../../.html all over the code #849)

Checklist for merging

  • Updated changelog entry
  • Documentation updated
  • Update conf.py

Checklist for release

  • Merge into main
  • Create release from the main branch with appropriate tag
  • Delete feature-branch

Testing Datasets

  • Dataset needed for testing available upon request
  • Dataset download instructions included
  • No dataset needed

@hkershaw-brown hkershaw-brown changed the title Undup doc obs conv Remove duplicated list of observation converters Mar 6, 2026
@hkershaw-brown hkershaw-brown added release! bundle with next release labels Mar 10, 2026
Copy link
Contributor

@mjs2369 mjs2369 left a comment

Choose a reason for hiding this comment

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

All the readmes for the obs converters are all in the observations/obs_converters/name_of_converter directory.

EX: observations/obs_converters/BATS/readme.rst

But the CHAMP obs converter readme is in the work dir: observations/obs_converters/CHAMP/work/README.rst

Copy link
Contributor

Choose a reason for hiding this comment

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

I think that these links to email the DART group should instead just list the dart email.

EX: "... is not in the repository, please email the DART
group at dart@ucar.edu"

These links open the mail app, which not everyone uses as many just use the browser.

Copy link
Member Author

Choose a reason for hiding this comment

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

changed in a947a22

Note sphinx does convert emails to mailbox open links automatically. So if you click the email it will still attempt to open mail box.

@hkershaw-brown
Copy link
Member Author

All the readmes for the obs converters are all in the observations/obs_converters/name_of_converter directory.

EX: observations/obs_converters/BATS/readme.rst

But the CHAMP obs converter readme is in the work dir: observations/obs_converters/CHAMP/work/README.rst

I dig that you brought this up, and I can move it because it has an anchor to link to.
fixed in 9f746d1

@hkershaw-brown hkershaw-brown requested a review from mjs2369 March 16, 2026 14:32
Copy link
Contributor

@mjs2369 mjs2369 left a comment

Choose a reason for hiding this comment

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

Good stuff!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release! bundle with next release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc: we have two lists of available observation converters in the docs

2 participants