-
Notifications
You must be signed in to change notification settings - Fork 350
Reorganize documentation #647
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
Open
Jacob-Stevens-Haas
wants to merge
11
commits into
master
Choose a base branch
from
refactor-docs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also bump python version and add myself to a few repo email links
Also add citation.cff
Also fix typo in rummary.rst
The goal of this commit is to allow building a bit more sensible docs. Instead of a massive file with modules and submodules and classes all documented on the same page, this has one top-levelobject (module, class, or function) documented on each web page, akin to scikitlearn e.g. https://scikit-learn.org/stable/api/sklearn.multiclass.html There is one significant practical decision to make: we need to be clear about from where we expect an object to be imported. E.g. I've chosen to hide documentation of modules like sr3.py and instead document all optimizer classes under pysindy.optimizers. We can't do it in two places. This also means that pysindy/pysindy.py became pysindy/_core.py, so that SINDy is documented in the main pysindy package namespace. There's some other small flattening, but largely, I expect to hide more and more modules with an underscore as time goes on, so that helper functions don't end up as part of a backwards compatability contract. This isn't the final word in the page layouts. There's a lot more visual improvements that can be made. But this commit should solve the technical problems and allow us to tweak from here.
87ee7da
to
133a654
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #647 +/- ##
==========================================
- Coverage 95.04% 95.03% -0.01%
==========================================
Files 39 38 -1
Lines 4114 4106 -8
==========================================
- Hits 3910 3902 -8
Misses 204 204 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Major reorganization of documentation. The goals here were to:
SINDy
object currently documented both aspysindy.SINDy
andpysindy.pysindy.SINDy
. Don't do this. Also, don't document individual modules whose only purpose is to export a class to the containing package, e.g.pysindy.differentiation.finite_difference
)A few things I especially want feedback on:
pysindy.optimizers.constrained_sr3
becomes herepysindy.optimizers._constrained_sr3
, but theConstrainedSR3
object is still documented inpysindy.optimizers
(and still importable both asfrom pysindy import ConstrainedSR3
andfrom pysindy.optimizers import ConstrainedSR3
)?Some considerations and future work:
set_fit_request()
, a metadata method that everyBaseEstimator
has.@yyexela I know I promised before graduation that I would fix the pysindy docs sometime this summer - here you go.
Todo
Better docstring linting tool #648
Tarball of built docs