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

Add initial docs #58

Merged
merged 5 commits into from
Sep 27, 2024
Merged

Add initial docs #58

merged 5 commits into from
Sep 27, 2024

Conversation

pjanevskiTT
Copy link
Contributor

@pjanevskiTT pjanevskiTT commented Sep 12, 2024

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

  • Wait for "New" TTDevice class #40 to know which API to document, is it still going to be tt_device class or tt_umd.h file -> Documenting tt_device
  • Open follow up issue to add sphinx tools like in metal and build full page same as Metal docs -> Follow up Add Sphinx docs #59
  • Add script to install requirements for doxygen

device/tt_device.h Outdated Show resolved Hide resolved
@vtangTT vtangTT force-pushed the metal-main branch 6 times, most recently from 83c55b8 to 378bba9 Compare September 13, 2024 17:28
@pjanevskiTT pjanevskiTT mentioned this pull request Sep 16, 2024
3 tasks
@pjanevskiTT pjanevskiTT changed the base branch from metal-main to main September 16, 2024 11:32
.gitignore Outdated Show resolved Hide resolved
Doxyfile Show resolved Hide resolved
Doxyfile Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/run_build_docs.sh Outdated Show resolved Hide resolved
device/tt_device.h Outdated Show resolved Hide resolved
Copy link
Contributor

@broskoTT broskoTT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with suggestions

@pjanevskiTT pjanevskiTT marked this pull request as ready for review September 20, 2024 09:12
@pjanevskiTT
Copy link
Contributor Author

pjanevskiTT commented Sep 26, 2024

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

  • Easier to edit
  • clang ruins table format
  • Broad audience more familiar with doxygen style

Since it is a bit difficult to say when @brief notation should be used, and we also have quite long function descriptions sometimes, it is not used in any function description

Copy link
Contributor

@joelsmithTT joelsmithTT left a 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!

@pjanevskiTT pjanevskiTT merged commit 201e2f0 into main Sep 27, 2024
11 of 12 checks passed
@pjanevskiTT pjanevskiTT deleted the pjanevskiTT/docs branch September 27, 2024 03:23
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

Successfully merging this pull request may close these issues.

API documentation
3 participants