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

Generate a docs table for file format examples #1622

Merged
merged 19 commits into from
Sep 17, 2024
Merged

Generate a docs table for file format examples #1622

merged 19 commits into from
Sep 17, 2024

Conversation

annehaley
Copy link
Collaborator

@annehaley annehaley commented Aug 30, 2024

Resolves #1489

  • Create a new pooch datastore to fetch format example files
  • Write a function to open format examples and evaluate table columns
  • Write a function to save results to disk as an RST-formatted table
  • Invoke the file fetching and table generation as a step in mkdocs.sh
  • Copy parakon hosted files to a more accessible location
  • Confirm that all format examples are public, small enough to download during CI, multiframe if possible, and visually interesting

Sorry, something went wrong.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@annehaley annehaley marked this pull request as ready for review September 11, 2024 17:26
@annehaley annehaley requested a review from manthey September 11, 2024 17:26
Copy link
Member

@manthey manthey left a comment

Choose a reason for hiding this comment

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

Overall this is great.

@manthey
Copy link
Member

manthey commented Sep 13, 2024

Do you think it would be possible to make the format column have both a link and a tooltip using custom html? That is

.. raw:: html

   <a href="{reference_link}" title={long_name}>{col_value}</a>

should work (embedded in the rest of the table cell appropriately).

Copy link
Member

@manthey manthey left a comment

Choose a reason for hiding this comment

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

I'd love to figure out the tooltip-and-link rst so we can not have the word (spec) repeated in each row, but that could be a different PR.

I also wonder if we want to find or generate more relevant (e.g., either WSI or geospatial) samples for some of the download examples, but that, too, can be a different PR.

And, I note that a minor change in the PIL source will let it show GIF as multi-frame (the first image was palette mode which meant that we decided the image stack wasn't consistent enough to show the frames; see a different PR for handling this).

@annehaley annehaley force-pushed the format-table branch 2 times, most recently from 65742f4 to 16fdfe5 Compare September 17, 2024 18:52
@annehaley annehaley merged commit bf48775 into master Sep 17, 2024
21 checks passed
@annehaley annehaley deleted the format-table branch September 17, 2024 20:35
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.

File Format List
2 participants