DOC: fix docs after package reorganization #4
Conversation
TODO: eventually, this should be removed from the repo
| del get_versions | ||
|
|
||
|
|
||
| from . import jet_control # noqa |
There was a problem hiding this comment.
__all__ instead of noqa? Or just ignore this specific flake8 violation in setup.cfg?
There was a problem hiding this comment.
__all__ would be for from .jet_control import * - which we probably don't want.
noqa, once flake8 checks are re-enabled, will make it exempt from flake8 checking. Without it, flake8 would complain that jet_control is imported but unused.
| .. autoclass:: jet_control.JetControl | ||
| .. autoclass:: JetControl | ||
|
|
||
| .. autosummary:: |
There was a problem hiding this comment.
Does this render the autosummary table for all the stuff below? Never done it quite this way.
There was a problem hiding this comment.
I'm updating these at the request of @koglin and keeping them as close as possible to what he originally had.
We should definitely standardize/overhaul this at some point down the line.
2 participants
There's still a bunch of refactoring work to finish up, but I shouldn't have broken the docs completely.
TODO: need to move the built documentation out of the master branch.