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

Support for API docs in other programming languagee (Doxygen integration) #2171

Open
sloede opened this issue Jul 5, 2023 · 2 comments
Open
Labels
Type: Plugin A feature that should be implemented as a separate package.

Comments

@sloede
Copy link

sloede commented Jul 5, 2023

Is there any way I can use Documenter.jl to show API documentation for source code written in another language? Specifically, I have a project with both C and Julia code and would optimally like to have the APIs both shown in Documenter.jl.

Or is there maybe a way to massage/postprocess data generated by Doxygen?

@mortenpi mortenpi added Type: Question Type: Plugin A feature that should be implemented as a separate package. and removed Type: Question labels Jul 5, 2023
@mortenpi
Copy link
Member

mortenpi commented Jul 10, 2023

Could you turn the C API docs into Julia docstrings? You could parse the Doxygen output and then dynamically construct the Julia objects and docstrings. Alternatively, I would suggest looking into hacking Documenter, doing it as some kind of a plugin.

@sloede
Copy link
Author

sloede commented Aug 17, 2023

We looked at this for a while but realized that it is way too much effort for the little amount of non-Julia code we need with a documented API. We thus decided to host a small doxygen page as a subsite of our main Documenter.jl-driven documentation site.

I think it would still be worthwhile to be able to include this in Documenter.jl, thus I'll leave this open for now (but feel free to close if you want to declutter the issue list).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Plugin A feature that should be implemented as a separate package.
Projects
None yet
Development

No branches or pull requests

2 participants