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

Document C code API #13

Open
npetersen2 opened this issue Dec 27, 2021 · 0 comments
Open

Document C code API #13

npetersen2 opened this issue Dec 27, 2021 · 0 comments

Comments

@npetersen2
Copy link
Contributor

This issue comes from the AMDC-Firmware repo: Severson-Group/AMDC-Firmware#133


Now that the C code is maturing (i.e. ./drv/foo.c), we should make detailed documents about how to use them from a user perspective.

This should include:

For drivers:

  1. Brief explanation of how the internals of the driver work. Should link to the IP core docs if appropriate.
  2. Index of all available function calls and what they do.
  3. Example code which exercises the driver.

Similar for system code.


I think we should make use of the Sphinx autodocs feature, but this will take a bit of work to figure out how to robustly use... Since the code is in a different repo. So, might have to make a submodule in this repo, docs.amdc.dev, then, on docs build, the build scripts checkout a given release branch of the AMDC-Firmware and then auto-build the API docs...

This will involve a big push in the source C file documentation with lots of comments added, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant