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.

Sign up for GitHub

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

Jump to bottom

Regenerate API docs #2344

Open
penelopeysm opened this issue Sep 25, 2024 · 1 comment · May be fixed by #2347
Open

Regenerate API docs #2344

penelopeysm opened this issue Sep 25, 2024 · 1 comment · May be fixed by #2347
Assignees
@penelopeysm

Comments

@penelopeysm
Copy link
Member

There are no API docs for Turing, thus there is no documentation for things inside Turing (e.g. samplers) and also no way to find out what symbols are exported (without looking at the source code).

Should make a basic Documenter setup and fix everything that it complains about.
@penelopeysm penelopeysm self-assigned this Sep 25, 2024
@penelopeysm
Copy link
Member Author

I thought this would be straightforward, but it's going to take some time :D

Symbols are being imported/exported and we need to be clear about where things are being exported from. Also some things aren't documented so we need to get them documented too.

A preview:

Screenshot 2024-09-25 at 19 35 03

@penelopeysm penelopeysm linked a pull request Sep 27, 2024 that will close this issue
Open
@penelopeysm penelopeysm mentioned this issue Oct 6, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@penelopeysm penelopeysm

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Generate API docs TuringLang/Turing.jl
1 participant
@penelopeysm