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

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

ParagEkbote
Copy link

@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 mkdocs serve in the terminal.

To build pages: run mkdocs 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
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
1 participant