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 filters documentation #901

Merged
merged 6 commits into from
Feb 5, 2022
Merged

Conversation

mkitti
Copy link
Member

@mkitti mkitti commented Feb 5, 2022

Fix #893

@mkitti mkitti requested a review from musm February 5, 2022 00:37
@mkitti
Copy link
Member Author

mkitti commented Feb 5, 2022

@simonbyrne would you like to take a look at the documentation for the HDF5 filters interface?

@mkitti
Copy link
Member Author

mkitti commented Feb 5, 2022

Let's just merge this. It is is easier to review and iterate after CI has generated and deployed the docs.

docs/src/filters.md Outdated Show resolved Hide resolved
@simonbyrne
Copy link
Collaborator

You can enable push_preview in documented which will build preview docs for PRs

@musm
Copy link
Member

musm commented Feb 5, 2022

You can enable push_preview in documented which will build preview docs for PRs

https://github.com/JuliaIO/HDF5.jl/blob/master/docs/make.jl#L39

It's enabled, but won't work across forks.

@musm musm merged commit bec2017 into JuliaIO:master Feb 5, 2022
@mkitti
Copy link
Member Author

mkitti commented Feb 5, 2022

We'll either need to dev the the plugin packages into the documentation environment or release new versions of them. Which do you prefer?

@musm
Copy link
Member

musm commented Feb 5, 2022

Hmm, I don't have a strong preference for either.

I think I'll just bump every filter package and HDF5 in the next round, and that'll sync them up.

@musm musm deleted the mk/filter_docs branch February 5, 2022 19:20
@musm musm restored the mk/filter_docs branch February 5, 2022 19:20
@simonbyrne
Copy link
Collaborator

In other cases where I've had sub packages, I've found it easier to check in the Manifest.

@mkitti
Copy link
Member Author

mkitti commented Feb 5, 2022

OK, I pushed my branch within the repository with a Manifest.toml: #903.

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 v0.16 docs to reflect filter interface changes
3 participants