-
Notifications
You must be signed in to change notification settings - Fork 6
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
Add initial docs #58
Add initial docs #58
Conversation
83c55b8
to
378bba9
Compare
db7ec27
to
fdca2d8
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved with suggestions
Per offline discussion, tt-umd is going to implement doxygen style. Since tt-metal has both table format and doxygen style comments, it can be changed to doxygen style in tt-metal to keep consistency. Multiple things in favour of doxygen style comments that were brought up
Since it is a bit difficult to say when |
286cacf
to
dc89313
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did the doc build and am looking at the HTML output -- looks great!
dc89313
to
e301694
Compare
Fixes #48
Add initial setup on how we want to build docs
This PR is going to be in draft just as a discussion whether this is the way we want to build the docs. Doxygen is used and the format for the functions is same metal uses for host API, compute kernel API etc.
TODOs
tt_device
class ortt_umd.h
file -> Documenting tt_devicesphinx
tools like in metal and build full page same as Metal docs -> Follow up Add Sphinx docs #59