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.

Sign up for GitHub

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

Jump to bottom

Python autodoc #64

Open
ByronHsu opened this issue Aug 24, 2024 · 3 comments · May be fixed by #485
Open

Python autodoc #64

ByronHsu opened this issue Aug 24, 2024 · 3 comments · May be fixed by #485
Assignees
@ParagEkbote
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers p0

Comments

@ByronHsu
Copy link
Collaborator

🚀 The feature, motivation and pitch

Create nice python autodoc which generating doc from python comments. Like https://triton-lang.org/main/index.html or https://github.com/vllm-project/vllm

Alternatives

No response

Additional context

No response
@ByronHsu ByronHsu added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 24, 2024
@ByronHsu
Copy link
Collaborator Author

https://about.fastht.ml/
https://nbdev.fast.ai/tutorials/docs_only.html
https://nbdev.fast.ai/

recommended by Jeremy

@yundai424 yundai424 added the p0 label Sep 4, 2024
@shimizust shimizust removed their assignment Sep 6, 2024
@ParagEkbote
Copy link

@ByronHsu Could you please assign this issue to me? I've begun to implement the same using Sphinx, since it is well compatible with PyTorch, rather than the options you have mentioned.

Reference:

  1. https://www.sphinx-doc.org/en/master/index.html
  2. https://github.com/ParagEkbote/Liger-Kernel

@ByronHsu
Copy link
Collaborator Author

awesome. thank you for taking this up

@ParagEkbote ParagEkbote mentioned this issue Oct 28, 2024
Closed
@ParagEkbote ParagEkbote linked a pull request Dec 17, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ParagEkbote ParagEkbote

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers p0
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Create Docs for Liger-Kernel ParagEkbote/Liger-Kernel
4 participants
@ByronHsu @yundai424 @ParagEkbote @shimizust