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

Render custom stan functions using Doxygen #423

Open
seabbs opened this issue Jan 3, 2024 · 0 comments
Open

Render custom stan functions using Doxygen #423

seabbs opened this issue Jan 3, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@seabbs
Copy link
Collaborator

seabbs commented Jan 3, 2024

Is your feature request related to a problem? Please describe.
The current stan documentation (added in #422) follows the suggested format in the stan docs which themselves are based on Doxygen. However, this documentation is not currently rendered so is hard to navigate and in some cases read.

Describe the solution you'd like
Using Doxygen to render our documentation similarly to done here. Note there is no official stan support and this example is the only one I have seen. Once this is in place we would also need to clearly link from the main package site.

Describe alternatives you've considered
A different documentation system but it is not clear to me what this would be.

@sbfnk @jamesmbaazam might be interested in this for EpiNow2.

@seabbs seabbs added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Jan 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
Status: No status
Development

No branches or pull requests

1 participant