[WIP] Sphinx-style Documentation Setup#39
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🗂️ PR Category
📝 Description
This PR bootstraps a bilingual (English + 简体中文) Sphinx documentation site for MagiCompiler, along with the CI workflow to deploy it to GitHub Pages. No source code, README, or existing CI is touched.
Docs toolchain & build
docs/requirements.txt— Sphinx +pydata-sphinx-theme+myst-parser+ablog+ i18n deps.docs/Makefile/docs/make.bat— build targets includinghtml-en,html-zh,html-multilang, andupdate-po..github/workflows/sphinx.yaml— builds English (site root) + Chinese (zh_CN/) and deploys to thegh-pagesbranch underdocs/main.Sphinx sources (
docs/source/)conf.py,index.md, custom CSS, and a language switcher template (English at root, Chinese underzh_CN/).user_guide/— starter pages (install,quickstart) forked/adapted from the current README.blog/— three technical posts ported from the existingdocs/*.md(why_magi_depyf,auto_cpu_offload,auto_cuda_graph_design) as ablog posts. Raw-HTML<img>blocks were converted to MyST{image}directives so assets are copied and paths resolve on the built site.Internationalization
docs/README.md/README_zh.md— contributor guide for building/writing/translating docs.docs/locale/zh_CN/LC_MESSAGES/*.po— full Chinese translations for all pages (UI strings, guides, and the three blog posts); code blocks, API names, commands, and URLs are kept verbatim.Verification:
make html-multilangbuilds both languages with zero warnings; the Chinese site renders translated content and the EN ⇄ 中文 switcher resolves correctly.