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

Make sure that all plugins have nice auto-generated documentation in Sphinx #56

Open
mithro opened this issue Nov 24, 2020 · 3 comments
Open

Make sure that all plugins have nice auto-generated documentation in Sphinx #56

mithro opened this issue Nov 24, 2020 · 3 comments

Comments

@mithro
Copy link
Collaborator

mithro commented Nov 24, 2020

All the plugins should have nice documentation published on Sphinx.
@mithro
Copy link
Collaborator Author

mithro commented Nov 24, 2020

@rw1nkler - What is the correct approach for this repo which is mostly C code? Something like the Verilog to Routing set up?

@mithro
Copy link
Collaborator Author

mithro commented Nov 24, 2020

@tmichalak -- Who should take on this work?

@rw1nkler
Copy link

rw1nkler commented Nov 24, 2020 •
edited

@rw1nkler - What is the correct approach for this repo which is mostly C code? Something like the Verilog to Routing set up?

A Sphinx setup for C/C++ code is simple. I can prepare it for this repository. The most important part is to document the code using Doxygen code comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mithro @rw1nkler