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

Documenter web page? #25

Closed
gdalle opened this issue Mar 9, 2024 · 2 comments · Fixed by #28
Closed

Documenter web page? #25

gdalle opened this issue Mar 9, 2024 · 2 comments · Fixed by #28

Comments

@gdalle
Copy link
Collaborator

gdalle commented Mar 9, 2024

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
@Vaibhavdixit02
Copy link
Member

I can set it up. But in case you had already done something for this I have added you to the repository.

@gdalle
Copy link
Collaborator Author

gdalle commented Mar 11, 2024

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?

@gdalle gdalle linked a pull request Mar 11, 2024 that will close this issue
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants