Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
/* ============================================
FLAGOS DOCUMENTATION - SHARED CUSTOM CSS
For sphinx_book_theme sub-projects
============================================ */

/* Adjust sphinx-book-theme navbar logo size */
.sidebar-primary-item .logo__image {
max-height: 45px !important;
width: auto !important;
}
5 changes: 2 additions & 3 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
sphinx==8.2.3
myst-parser
sphinx-multiproject==1.0.0
sphinx-rtd-theme
Expand All @@ -12,6 +13,4 @@ sphinx-pyscript
sphinx-tippy>=0.4.3
sphinx-togglebutton
sphinx-tabs==3.4.7
sphinx-prompt==1.10.2
sphinx-tippy>=0.4.3
sphinx-togglebutton
sphinx-prompt==1.10.2
14 changes: 9 additions & 5 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,16 +66,20 @@
locale_dirs = ["locale/"]
gettext_compact = False # Generate separate POT file for each source file

# Detect the actual build language from Read the Docs environment variable
# Falls back to the language config variable for local builds
CURRENT_LANGUAGE = os.getenv("READTHEDOCS_LANGUAGE", language)

# -- HTML output -------------------------------------------------------------

html_theme = "sphinx_book_theme"
html_static_path = ["../_static"]
html_css_files = []
html_css_files = ["css/custom.css"]
html_js_files = []

# Logo and favicon configuration based on language
# Read the Docs builds each language separately with -D language=zh_CN
if language == "zh_CN":
# Logo and favicon configuration based on build language
# Read the Docs sets READTHEDOCS_LANGUAGE environment variable during builds
if CURRENT_LANGUAGE == "zh_CN":
html_logo = "../_static/images/logos/zh-logo.svg"
html_theme_options = {
"home_page_in_toc": True,
Expand All @@ -89,7 +93,7 @@
},
}
else:
# Default to English
# Default to English configuration for all other languages
html_logo = "../_static/images/logos/en-logo.svg"
html_theme_options = {
"home_page_in_toc": True,
Expand Down
2 changes: 1 addition & 1 deletion docs/source/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Test with a single {term}`Operator` to verify everything works:
python scripts/generate_kernel_and_verify.py \
--op-name aten::add \
--single-test \
--server-type openai \
--server-type openai \s
--model-name gpt-4o \
--max-rounds 3
```
Expand Down
62 changes: 61 additions & 1 deletion docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Evaluate LLMs on generating Triton kernels with Pass@K metric.
[Learn more »](operation-guide/llm-track/index)
:::

:::{grid-item-card} {octicon}`hub;1.5em;sd-mr-1` Agent Track
:::{grid-item-card} {octicon}`hubot;1.5em;sd-mr-1` Agent Track
:link: operation-guide/agent-track/index
:link-type: doc

Expand Down Expand Up @@ -156,3 +156,63 @@ development/extending.md
faq/index.md
glossary/index.md
```

```{toctree}
:caption: 🔬 Features
:maxdepth: 2
:hidden:

features/index.md
features/multi-source.md
features/multi-chip.md
features/anti-hack.md
features/metrics.md
```

```{toctree}
:caption: 📖 Operation Guide
:maxdepth: 3
:hidden:

operation-guide/index.md
operation-guide/llm-track/index.md
operation-guide/llm-track/commands.md
operation-guide/llm-track/parameters.md
operation-guide/llm-track/examples.md
operation-guide/agent-track/index.md
operation-guide/agent-track/setup.md
operation-guide/agent-track/methods.md
operation-guide/agent-track/commands.md
operation-guide/agent-track/cost-analysis.md
```

```{toctree}
:caption: 📑 Reference
:maxdepth: 2
:hidden:

reference/index.md
reference/datasets.md
reference/operators.md
reference/hardware.md
```

```{toctree}
:caption: 🔧 Development
:maxdepth: 2
:hidden:

development/index.md
development/contributing.md
development/custom-operators.md
development/extending.md
```

```{toctree}
:caption: ❓ FAQ & Glossary
:maxdepth: 2
:hidden:

faq/index.md
glossary/index.md
```
10 changes: 5 additions & 5 deletions docs/source/locale/zh_CN/LC_MESSAGES/getting-started/index.po
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: KernelGenBench Documentation \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2026-06-15 18:12+0800\n"
"POT-Creation-Date: 2026-06-17 11:11+0800\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: zh_CN\n"
Expand Down Expand Up @@ -150,7 +150,7 @@ msgstr "描述"

#: ../../source/getting-started/index.md
#, python-brace-format
msgid "{term}`KernelGenBench`"
msgid "`{term}`KernelGenBench``"
msgstr "{term}`KernelGenBench`"

#: ../../source/getting-started/index.md
Expand All @@ -164,7 +164,7 @@ msgstr "完整集合({term}`ATen` + {term}`vLLM` + {term}`cuBLAS`)"

#: ../../source/getting-started/index.md
#, python-brace-format
msgid "{term}`KernelGenBench-aten`"
msgid "`{term}`KernelGenBench-aten``"
msgstr "{term}`KernelGenBench-aten`"

#: ../../source/getting-started/index.md
Expand All @@ -178,7 +178,7 @@ msgstr "仅 {term}`ATen` 算子"

#: ../../source/getting-started/index.md
#, python-brace-format
msgid "{term}`KernelGenBench-vllm`"
msgid "`{term}`KernelGenBench-vllm``"
msgstr "{term}`KernelGenBench-vllm`"

#: ../../source/getting-started/index.md
Expand All @@ -192,7 +192,7 @@ msgstr "仅 {term}`vLLM` 算子(仅限 NVIDIA)"

#: ../../source/getting-started/index.md
#, python-brace-format
msgid "{term}`KernelGenBench-cublas`"
msgid "`{term}`KernelGenBench-cublas``"
msgstr "{term}`KernelGenBench-cublas`"

#: ../../source/getting-started/index.md
Expand Down
Loading
Loading