mirror of
https://github.com/openmlsys/openmlsys-zh.git
synced 2026-03-20 20:17:03 +08:00
6c9673a659
* build: add mdbook support for zh chapters
Add mdBook configuration rooted at zh_chapters, generate and commit SUMMARY.md, rewrite d2l-specific directives through a Python preprocessor, refresh chapter resource symlinks from the build scripts, and ignore local build-only links and helper directories.
* feat: add raw HTML inline and frontpage layout support for mdbook preprocessor
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* feat: add dark mode image background for mdbook dark themes
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* fix: add resource symlinks and repo root static fallback to mdbook build
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* feat: add BibTeX citation support with inline links and bibliography
Parse mlsys.bib to generate author-year inline citations linked to
per-page bibliography sections. Missing bib keys degrade gracefully
to plain text placeholders.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* refactor: switch citation display to footnote style
Use numbered superscript references [1] [2] inline with an ordered
list bibliography at page bottom. Each entry has a back-link (↩)
to the citation site.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* fix: strip LaTeX escapes outside math mode in mdbook preprocessor
Remove \_, \%, \#, \& escapes from text outside $...$ math spans
while preserving them inside math mode for MathJax compatibility.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* style: set frontpage author grid to 6 columns and widen main content area
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* fix: group mdbook toc by part titles
* fix: enable inline math rendering in mdbook
* build: migrate docs publishing to mdbook
Move the English root site to mdBook, keep the Chinese site as a sub-book, and update CI/deploy to publish .mdbook outputs to docs/ and docs/cn/. Also add regression coverage for placeholder skipping, publish-tree assembly, and shared resource setup.
* ci: use official pages deployment workflow
Switch the docs deployment workflow to the official GitHub Pages actions flow and verify it uses Pages action outputs for the deployment URL.
* feat: add homepage language switch links
Inject a homepage-only language switch into the mdBook frontpage wrapper so the English homepage links to the Chinese homepage and the Chinese homepage links back to the English homepage.
* fix: correct english homepage frontpage
Add an English-specific frontpage template so the default homepage no longer falls back to the Chinese frontpage, and clear homepage image backgrounds in the frontpage wrapper CSS.
* fix: align english homepage author grid
Top-align the English homepage author cards, enlarge the row gap, and normalize avatar sizing so author portraits line up consistently.
* fix: restore dark mode body image backgrounds
Apply light gray backgrounds to body images in dark themes for both English and Chinese mdBook themes while explicitly excluding homepage frontpage images.
* fix: restyle homepage language switch button
Move the homepage language switch below the GitHub star button and restyle it to match the same button family on both the English and Chinese homepages.
* fix: center homepage content container
Align the English and Chinese homepage frontpage wrapper with the main content container so homepage content is centered like normal body content.
* fix: stack english homepage footer copy
Keep the English homepage contributor and errata footer lines in normal block flow so each sentence stays on its own line instead of being laid out as author-grid columns.
* fix: widen centered homepage container
Keep the homepage frontpage wrapper centered while ensuring it uses at least 80% of the available content area, without changing normal body page layout.
* fix: widen homepage main content area
Apply a homepage-only override so mdbook-content > main uses at least 80% of the available content width while keeping normal body pages on the default layout.
* ci: use peaceiris action for mdbook
Replace manual mdBook installation in CI and Pages workflows with peaceiris/actions-mdbook@v2 and keep a regression test to ensure the action stays in use.
* fix: reduce homepage main width floor
Lower the homepage-only mdbook-content > main minimum width from 80% to 65% while leaving normal body pages unchanged.
* build: switch math rendering to mdbook-katex
Use mdbook-katex in pre-render mode for both books, pin mdBook to a compatible version, update build scripts and workflows, and replace the old MathJax regression tests with KaTeX coverage.
* Revert "build: switch math rendering to mdbook-katex"
This reverts commit b9cf38a5d1.
* build: switch math rendering from MathJax to mdbook-typst-math
* ci: deploy docs to openmlsys.github.io repo
* fix: convert pandoc tables to GFM pipe tables for mdbook
* feat: convert :eqlabel:/:eqref: to MathJax \tag/\label/\eqref
- Add process_equation_labels() to inject \tag{n}\label{name} into
preceding $$ equations, replacing :eqlabel: directives
- Change :eqref: conversion from backtick code to $\eqref{name}$
for clickable cross-references
- Add TeX.equationNumbers.autoNumber:"none" to MathJax config to
prevent conflicts with manual \tag numbering
- Add tests for single-line, multi-line, and sequential numbering
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* ci: cache mdbook-typst-math binary in workflows
* feat: add LaTeX-to-Typst math converter with eqref/tag support
* feat: integrate LaTeX-to-Typst conversion into zh preprocessor
* fix: strip LaTeX escapes only outside math spans and code blocks
* fix: load references/*.bib so all citations render correctly
* fix: skip citations with no bib entry instead of rendering raw keys
* ci: remove redundant CI workflow, keep only deploy workflow
* ci: Add CI workflow for testing and building mdBook
* ci: remove concurrency settings from update_docs.yml
Removed concurrency settings from the update_docs workflow.
---------
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
88 lines
3.2 KiB
Python
88 lines
3.2 KiB
Python
from __future__ import annotations
|
|
|
|
import tempfile
|
|
import unittest
|
|
from pathlib import Path
|
|
|
|
from tools.assemble_docs_publish_tree import assemble_publish_tree
|
|
|
|
|
|
class AssembleDocsPublishTreeTests(unittest.TestCase):
|
|
def test_assemble_publish_tree_uses_legacy_docs_layout(self) -> None:
|
|
with tempfile.TemporaryDirectory() as tmpdir:
|
|
root = Path(tmpdir)
|
|
pages_repo = root / "pages"
|
|
en_source = root / "en-html"
|
|
zh_source = root / "zh-html"
|
|
|
|
pages_repo.mkdir()
|
|
en_source.mkdir()
|
|
zh_source.mkdir()
|
|
|
|
(en_source / "index.html").write_text("english home", encoding="utf-8")
|
|
(en_source / "guide.html").write_text("english guide", encoding="utf-8")
|
|
(zh_source / "index.html").write_text("chinese home", encoding="utf-8")
|
|
(zh_source / "searchindex.js").write_text("zh search", encoding="utf-8")
|
|
|
|
assemble_publish_tree(
|
|
destination_root=pages_repo,
|
|
docs_subdir="docs",
|
|
en_source=en_source,
|
|
zh_source=zh_source,
|
|
)
|
|
|
|
self.assertEqual(
|
|
(pages_repo / "docs" / "index.html").read_text(encoding="utf-8"),
|
|
"english home",
|
|
)
|
|
self.assertEqual(
|
|
(pages_repo / "docs" / "guide.html").read_text(encoding="utf-8"),
|
|
"english guide",
|
|
)
|
|
self.assertEqual(
|
|
(pages_repo / "docs" / "cn" / "index.html").read_text(encoding="utf-8"),
|
|
"chinese home",
|
|
)
|
|
self.assertEqual(
|
|
(pages_repo / "docs" / "cn" / "searchindex.js").read_text(encoding="utf-8"),
|
|
"zh search",
|
|
)
|
|
|
|
def test_assemble_publish_tree_replaces_stale_docs_content(self) -> None:
|
|
with tempfile.TemporaryDirectory() as tmpdir:
|
|
root = Path(tmpdir)
|
|
pages_repo = root / "pages"
|
|
en_source = root / "en-html"
|
|
zh_source = root / "zh-html"
|
|
|
|
(pages_repo / "docs" / "cn").mkdir(parents=True)
|
|
(pages_repo / "docs" / "old.html").write_text("stale en", encoding="utf-8")
|
|
(pages_repo / "docs" / "cn" / "old.html").write_text("stale zh", encoding="utf-8")
|
|
|
|
en_source.mkdir()
|
|
zh_source.mkdir()
|
|
(en_source / "index.html").write_text("fresh en", encoding="utf-8")
|
|
(zh_source / "index.html").write_text("fresh zh", encoding="utf-8")
|
|
|
|
assemble_publish_tree(
|
|
destination_root=pages_repo,
|
|
docs_subdir="docs",
|
|
en_source=en_source,
|
|
zh_source=zh_source,
|
|
)
|
|
|
|
self.assertFalse((pages_repo / "docs" / "old.html").exists())
|
|
self.assertFalse((pages_repo / "docs" / "cn" / "old.html").exists())
|
|
self.assertEqual(
|
|
(pages_repo / "docs" / "index.html").read_text(encoding="utf-8"),
|
|
"fresh en",
|
|
)
|
|
self.assertEqual(
|
|
(pages_repo / "docs" / "cn" / "index.html").read_text(encoding="utf-8"),
|
|
"fresh zh",
|
|
)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|