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 Sphinx docs #59

Open
3 tasks
pjanevskiTT opened this issue Sep 16, 2024 · 2 comments
Open
3 tasks

Add Sphinx docs #59

pjanevskiTT opened this issue Sep 16, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers P2 Minor issues

Comments

@pjanevskiTT
Copy link
Contributor

pjanevskiTT commented Sep 16, 2024

This issue is follow up #58, which is going to add initial docs to tt_device API which is exposed from UMD.

Use docs setup from #58 to add Sphinx docs similar to tt-metal. Since we are going to change the API quite a bit in the following period, we are going to add Sphinx when new API is established.

General TODOs for the issue

  • Use doxygen created docs to create webpage using Sphinx
  • Copy design from tt-metal for the Sphinx webpage
  • Setup something like docs requirements and update docs README with instructions how to generate the webpage
@pjanevskiTT pjanevskiTT added documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 16, 2024
@pjanevskiTT pjanevskiTT mentioned this issue Sep 16, 2024
3 tasks
@KisuZoid
Copy link

I would like to work on it

@pjanevskiTT pjanevskiTT added the P2 Minor issues label Nov 5, 2024
@broskoTT
Copy link
Contributor

broskoTT commented Nov 6, 2024

@KisuZoid Apologies for the late reply.
In general, we celebrate external contributions to our open source repositories. Feel free to create a PR with these changes.

But do mind that, at some point, someone from our team will pick this up in one of our iterations.

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 good first issue Good for newcomers P2 Minor issues
Projects
None yet
Development

No branches or pull requests

3 participants