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

Replace manual table for calculations in docs #1382

Open
dopplershift opened this issue May 28, 2020 · 1 comment
Open

Replace manual table for calculations in docs #1382

dopplershift opened this issue May 28, 2020 · 1 comment
Labels
Area: Docs Affects documentation Area: Infrastructure Pertains to project infrastructure (e.g. CI, linting) Type: Enhancement Enhancement to existing functionality

Comments

@dopplershift
Copy link
Member

Had an idea occur to me to make maintaining the list of calculations in the docs easier. Instead of needing to manually list every calculation, I think we would be able to:

  1. Re-organize calculations so that every heading/sub-table corresponds to a single module.
  2. Replace manual tables with auto-summary of the module

It'd also be interesting to investigate whether we can replace the headings in the file with just putting the right stuff in module-level docstrings--then maybe we can totally eliminate the template?

One potential pitfall here is that we want all of these exposed under metpy.calc and not show the sub-module. That might still require some templating, but I still would love to reduce the amount of manual effort.

@dopplershift dopplershift added Area: Docs Affects documentation Area: Infrastructure Pertains to project infrastructure (e.g. CI, linting) Type: Enhancement Enhancement to existing functionality labels May 28, 2020
@jthielen
Copy link
Collaborator

A custom template will almost certainly still be required based on what I can recall from implementing #889, but with a bit more effort put into it, I don't see why it couldn't be a more automatic listing like you suggest.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Docs Affects documentation Area: Infrastructure Pertains to project infrastructure (e.g. CI, linting) Type: Enhancement Enhancement to existing functionality
Projects
None yet
Development

No branches or pull requests

2 participants