-
Notifications
You must be signed in to change notification settings - Fork 21
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
Comments
I looked at this again and it really looks like it is just a case of telling Doxgyen that the stan file is a c++ file (in the Doxyfile) and then using the documentation approach they have taken in their stan functions (which has some slight differences to what we have so far). Given this I think this should be higher priority and have moved it up a version. If anyone wants to take this on that would be great but if not I am happy to. |
I'm taking a stab at this in preparation for the linked issue in EpiNow2. @seabbs What is desired output format? Options include PDF, HTML, etc. Who do we want to expose this to? I would imagine it's more of a developer doc? |
I think we want to output it to a website very much like the linked That would be great! |
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
.The text was updated successfully, but these errors were encountered: