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

Review API reference #6

Closed
greenbreakfast opened this issue Nov 14, 2020 · 1 comment
Closed

Review API reference #6

greenbreakfast opened this issue Nov 14, 2020 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@greenbreakfast
Copy link
Contributor

greenbreakfast commented Nov 14, 2020

Try following the instructions in docs/README.md to build the docs

Review the API reference and see if there's a better way to present the information.

Source code for the api reference document can be found here: https://github.com/OnionIoT/tau-lidar-camera/blob/master/docs/api.rst
It's written in reStructuredText

See also OnionIoT/tau-lidar-common#1

@greenbreakfast greenbreakfast added the documentation Improvements or additions to documentation label Nov 14, 2020
@vsemi vsemi self-assigned this Nov 17, 2020
@vsemi
Copy link
Collaborator

vsemi commented Nov 26, 2020

@greenbreakfast reviewed and modified comments for autodoc, generated locally and looks good now.

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

No branches or pull requests

2 participants