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.

Sign up for GitHub

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

Jump to bottom

Improve documentation #25

Open

7 tasks

monkeyman192 opened this issue Oct 14, 2024 · 0 comments

Labels

Milestone

Owner

monkeyman192 commented Oct 14, 2024

Before the 0.2 release, we'll need to update the documentation to be far more complete
Some things to cover:

Background on how pymhf works
Using pymhf for single mods
API documentation (can this be automated using sphinx etc?)
Common issues
Basics on what is required for making a library
Common workflow set up for "local" testing
More example projects/mods

monkeyman192 added the documentation label

monkeyman192 added this to the v0.2 milestone

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