-
-
Notifications
You must be signed in to change notification settings - Fork 11
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
Documenter web page? #25
Comments
I can set it up. But in case you had already done something for this I have added you to the repository. |
Thanks! I can do it as well, once #26 is merged Once there is a nice page up and running we can bump the patch version and release, if that's okay? |
Merged
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Is your feature request related to a problem? Please describe.
Since #23 we have docstrings, but they are not shown anywhere right now. As a result, the API specification is still imprecise for users, which is a problem when so much of SciML depends on this package.
Describe the solution you’d like
A Documenter.jl web page showcasing the docstrings and the list of exported names.
Describe alternatives you’ve considered
I tried adding a list of exports to the README in #23, but it will become periodically out of date (it already is since #21 was merged too). A Documenter workflow is more adaptive.
Additional context
I can set up the Documenter stuff by myself, but there are things I cannot do:
The text was updated successfully, but these errors were encountered: