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

Consider whether LDoc could be leveraged for developer docs #1337

Closed
alerque opened this issue Mar 5, 2022 · 1 comment
Closed

Consider whether LDoc could be leveraged for developer docs #1337

alerque opened this issue Mar 5, 2022 · 1 comment
Labels
documentation Documentation bug or improvement issue
Milestone

Comments

@alerque
Copy link
Member

alerque commented Mar 5, 2022

On a related note to documentation overhauls in #1194 it might be interesting to look at whether LDoc can be leveraged. I would guess this would be more useful for the kind of documentation a package developer might need that a SILE user, but it's possible that better documentation of our own internals could be a benefit.

Two possible outcomes might be a set of developer API docs separate from the user manual using HTML output or writing some sort of wrapper that leverages LDoc to extract all the documentation information then uses SILE itself to typeset this as part of the manual.

@alerque
Copy link
Member Author

alerque commented Dec 15, 2023

We're also going to have Rust API docs. It might be worth looking at tealr too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation bug or improvement issue
Projects
None yet
Development

No branches or pull requests

1 participant