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

User documentation: examples #17

Open
angus-g opened this issue Aug 26, 2019 · 1 comment
Open

User documentation: examples #17

angus-g opened this issue Aug 26, 2019 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@angus-g
Copy link
Owner

angus-g commented Aug 26, 2019

We have the capability for autogenerated documentation (that appears at https://lagrangian-filtering.readthedocs.io/en/latest/). I've already put installation instructions and some API documentation up, but I think the next useful thing would be worked examples.

@angus-g angus-g added the documentation Improvements or additions to documentation label Aug 26, 2019
@angus-g
Copy link
Owner Author

angus-g commented Nov 5, 2019

Here's an example that would be perfect for the documentation: analytic_example_v2.pdf

I'll have a look at whether this should be autogenerated from an examples folder, or other ways of getting an exported notebook available.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant