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

Create Docs for Liger-Kernel #485

Merged
merged 28 commits into from
Jan 22, 2025
Merged

Conversation

ParagEkbote
Copy link
Contributor

@ParagEkbote ParagEkbote commented Dec 17, 2024

Summary

Fixes #64

Instead of using Sphinx which I found to be cumbersome to set-up and iterate upon, I have created the docs using Material for Markdown, which uses markdown files for pages and does not change the original markdown files to a greater extent.

To preview in your local system: run make serve in the terminal.

To build pages: run make build in the terminal.

Index page:

image

Examples page:

image

Please let me know if any styling or further corrections are needed and I will make the necessary changes.

cc: @ByronHsu

@lancerts lancerts requested a review from ByronHsu December 24, 2024 03:31
@ParagEkbote
Copy link
Contributor Author

Could you please review the changes?

cc: @ByronHsu

@ParagEkbote
Copy link
Contributor Author

Could you please review the changes?

cc: @ByronHsu

@ParagEkbote
Copy link
Contributor Author

Could you please review the changes?

cc: @ByronHsu

@ParagEkbote
Copy link
Contributor Author

Could you please review the changes?

cc: @ByronHsu

@ParagEkbote
Copy link
Contributor Author

Could you please provide me with an initial review? I'd really love to take this PR forward and work to address any required changes ☺️

cc: @lancerts

@lancerts lancerts requested a review from shivam15s January 17, 2025 17:20
@ByronHsu
Copy link
Collaborator

ByronHsu commented Jan 21, 2025

Hi @ParagEkbote! Sorry for the very late reply since we were focusing on something else. Thank you for the great work and i will try to merge it in 2 days. Can you join our slack channel https://join.slack.com/t/ligerkernel/shared_invite/zt-2yavnspqs-0AYy5jduuxd1GKMGlKgFTw? cc @hebiao064

@hebiao064
Copy link
Collaborator

The docs looks good to me, please add mkdocs and mkdocs-material into setup.py otherwise other user won't be able to run make serve and make build

Error would be like:
bash: mkdocs: command not found without mkdocs

Error: MkDocs encountered an error parsing the configuration file: while constructing a Python object cannot find module 'pymdownx.superfences' (No module named 'pymdownx') without mkdocs-material

@hebiao064
Copy link
Collaborator

Discussed with @ByronHsu, let's merge this nice PR first and we will fix the setup.py

Copy link
Collaborator

@hebiao064 hebiao064 left a comment

Choose a reason for hiding this comment

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

Thanks!

@hebiao064 hebiao064 merged commit 38aac93 into linkedin:main Jan 22, 2025
@ParagEkbote ParagEkbote deleted the create-docs branch January 22, 2025 03:44
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.

Python autodoc
3 participants