You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
Add the required secrets to the repo. If you want to give me access that's also fine.
Integrate this to a wider SciML multidoc. Not sure we want to do that though, because I envision this package being foundational outside of SciML too thanks to https://github.com/gdalle/DifferentiationInterface.jl
The text was updated successfully, but these errors were encountered:
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: