Skip to content

Commit 8807a54

Browse files
authored
[Fix] Deploy the Mkdocs site to github pages (#724)
## Summary Follow-up of #722 I've added a separate folder 'doc-site' to compile the site and modified the mkdocs.yml to that folder path so that when the github workflow is executed, the site content will be fetched from 'doc-site'. It is important to note that 'doc-site' cannot be placed under the docs folder since it leads to an error. I've also updated the Makefile to point towards the correct path as well. The deployed site is from my fork of the repo: https://paragekbote.github.io/Liger-Kernel/ Would like to add me a README note about the site or update the About section with the website link? Could you please let me know? cc: @shimizust <!--- ## Details This is an optional section; is there anything specific that reviewers should be aware of? ---> ## Testing Done <!--- This is a required section; please describe how this change was tested. ---> <!-- Replace BLANK with your device type. For example, A100-80G-PCIe Complete the following tasks before sending your PR, and replace `[ ]` with `[x]` to indicate you have done them. --> - Hardware Type: <BLANK> - [ ] run `make test` to ensure correctness - [ ] run `make checkstyle` to ensure code style - [ ] run `make test-convergence` to ensure convergence
1 parent 44a8f2f commit 8807a54

File tree

3 files changed

+13
-3
lines changed

3 files changed

+13
-3
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ venv/
1414
build/
1515
dist/
1616

17+
# Doc Build
18+
doc_site/
19+
1720
# Lockfiles
1821
uv.lock
1922

Makefile

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,19 @@ run-benchmarks:
4848
# MkDocs Configuration
4949
MKDOCS = mkdocs
5050
CONFIG_FILE = mkdocs.yml
51+
SITE_DIR = doc_site
5152

5253
# MkDocs targets
54+
55+
# Serve the documentation
5356
serve:
5457
$(MKDOCS) serve -f $(CONFIG_FILE)
5558

59+
# Build the documentation into the specified site directory
5660
build:
57-
$(MKDOCS) build -f $(CONFIG_FILE)
61+
$(MKDOCS) build -f $(CONFIG_FILE) --site-dir $(SITE_DIR)
5862

63+
# Clean the output directory
5964
clean:
60-
rm -rf site/
65+
rm -rf $(SITE_DIR)/
66+

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
site_name: Liger-Kernel Docs
2-
# site_url: ...
2+
site_dir: './doc_site'
3+
# site_url: https://linkedin.github.io/Liger-Kernel/
34
# site_author: LinkedIn
45
site_description: Efficient Triton Kernels for LLM Training
56
theme:

0 commit comments

Comments
 (0)