尧图网络科技YAOTU DIGITAL 获取报价
获取报价
首页 / 资讯中心 / 文章详情

Model Optimizer 文档化公告中心:基于 Sphinx 源码与 GitHub Pages 的公告发布体系解析

发布时间:2026/9/26 3:33:56

资讯中心
01
ARTICLE

Model Optimizer 文档化公告中心:基于 Sphinx 源码与 GitHub Pages 的公告发布体系解析

Model Optimizer 文档化公告中心:基于 Sphinx 源码与 GitHub Pages 的公告发布体系解析
【免费下载链接】Model-OptimizerA unified library of SOTA model optimization techniques like quantization, distillation, pruning, neural architecture search, speculative decoding, etc. It compresses deep learning models for downstream deployment frameworks like TensorRT-LLM, TensorRT, vLLM, etc. to optimize inference speed.项目地址https://gitcode.com/GitHub_Trending/te/Model-Optimizer点击查看免费下载Model Optimizer 将公告发布从独立的发布系统迁入 Sphinx 文档源码构建了一个文档同源、PR 评审、CI 自动部署的 GitHub Pages 公告枢纽。本文以 github-pages-announcements.rst 为主线结合仓库内index.rst、announcements.js/css、conf.py与.github/workflows/pages.yml的实现完整讲解公告落地页、卡片元数据、交互筛选、撰写流程与发布流水线读者可以据此为 Model Optimizer 新增一篇公告并理解整条发布链路。一、公告为什么要搬家到 GitHub PagesModel Optimizer 的 GitHub Pages 站点原先仅承载 API 文档。2026 年 8 月 13 日Model Optimizer 团队发布公告见 github-pages-announcements.rst站点将从纯 API 文档扩展为一个轻量级公告枢纽announcement hub。这一变更的核心目标是让发布说明release notes、技术笔记technical notes、示例examples与部署文章deployment writeups更容易被发现同时不引入独立的发布系统。也就是说公告内容与代码、文档共用同一条仓库与 CI 管线公告本身以 Sphinx 页面形式存在由 GitHub Pages 工作流从已提交的源码重建静态站点。二、变更要点公告从独立发布到文档同源原公告用四个要点概括了这次变更仓库实现与之一一对应变更要点仓库中的落地实现公告存放在文档源码中并通过 Pull Request 评审公告页面位于 docs/source/announcements/任何修改都走常规 PR 流程.github/workflows/pages.yml在 PR 事件上构建文档并部署预览落地页默认展示公告docs/source/index.rst 首页主体即公告索引announcement-section标题为 Announcements既有 API 文档保留在 Sphinx 左侧导航index.rst中保留了 Getting Started、Guides、Deployment、Examples、Reference、Support 等隐藏 toctreeAPI 文档照常从 Sphinx 左侧导航访问公告页支持标签、搜索、筛选与内嵌图片卡片级data-tags元数据 announcements.js 实现搜索/标签筛选/分页announcements/assets/目录存放内嵌图片一句话概括公告内容写进文档源码卡片元数据驱动前端交互CI 工作流负责构建与发布整个生命周期与代码演进完全同步。三、落地页实现index.rst中的 announcement-card 元数据公告索引页不是纯 toctree 拼装而是在 RST 中直接嵌入一段自定义 HTML其结构节选如下完整内容见 docs/source/index.rstsection classannouncement-section aria-labelAnnouncement index div classannouncement-toolbar label classannouncement-search-label forannouncement-searchSearch announcements/label input idannouncement-search classannouncement-search typesearch ... / div classannouncement-tags aria-labelAnnouncement tags button classannouncement-tag is-active typebutton>html_theme shibuya html_theme_options { accent_color: green, color_mode: auto, dark_code: True, globaltoc_expand_depth: 1, } html_static_path [_static] html_title fModel Optimizer {version} html_css_files [custom.css, announcements.css] html_js_files [announcements.js]其中html_css_files与html_js_files将公告样式与交互脚本注入全站sphinx.ext.githubpages也已在extensions列表中启用。也就是说公告枢纽从静态资源到交互逻辑都是 Sphinx 文档体系的原生组成部分。六、公告撰写流程Authoring Flow原公告给出的撰写流程是在docs/source/announcements/下新增一个 Sphinx 页面 → 在index.rst中添加其.announcement-card元数据 → 视情况把它挂入公告 toctree。结合仓库中现有五篇公告autoquantize.rst、dspark-vs-domino.rst、github-pages-announcements.rst、local-hessian.rst、qwen36-w4a4-qad.rst具体分四步第 1 步创建公告页面每篇公告都是一个独立的 RST 文件首行声明:orphan:页面不加入任何 toctreeSphinx 不会因此告警随后给出 Author、Date、Tags 元数据。以 local-hessian.rst 为例:orphan: Improving NVFP4 Accuracy with Local-Hessian Weight Scales ######################################################### :Author: Model Optimizer Team :Date: September 9, 2026 :Tags: local-hessian, quantization, nvfp4, calibration, modelopt公告正文可以包含.. image::指令引用announcements/assets/下的图片如曲线图、分布图并支持公式.. math::、list-table表格与.. note::提示块这正是公告页支持内嵌图片的落点。第 2 步在index.rst中登记卡片在index.rst的announcement-grid内新增article classannouncement-card填写data-date、data-title、data-summary、data-tags并把标题链接指向构建产物announcements/slug.html。搜索与标签筛选完全依赖这组元数据因此字段必须准确。第 3 步挂入公告 toctreeindex.rst的公告 toctree 使用self将首页自身作为入口如果后续公告需要独立目录条目可在该 toctree 中追加对应页面名。因为每篇公告都带:orphan:即使不挂 toctree 也不会触发构建警告卡片锚点仍可直接访问——这保持了轻量级的设计初衷。第 4 步提交 PR等待流水线公告与代码一样走 PR 评审.github/workflows/pages.yml会在 PR 事件opened / synchronize / reopened上触发文档构建并通过rossjrw/pr-preview-actionv1部署 PR 预览站点合并到 main 后由JamesIves/github-pages-deploy-actionv4正式发布到 gh-pages。这样每条公告都经历了与代码完全相同的评审路径。七、发布流水线.github/workflows/pages.yml.github/workflows/pages.yml工作流名Docs是从提交的源码重建静态站点的具体实现包含四个 JobJob触发条件作用build-docsPR 非 closed / push main / 每日 cron / 手动pip install nox uv nox -s docs构建文档产物输出到docs/build/html并上传为 artifactchanges仅 PR用dorny/paths-filterv4判断docs/**、modelopt/**与pages.yml是否变更作为是否部署预览的依据deploy-previewPR 且变更涉及文档或 PR 关闭清理下载文档产物用rossjrw/pr-preview-actionv1部署/移除 PR 预览Fork 出的 PR 因只读 token 会跳过避免 403deploy-gh-pagespush main / 每日 cron / 手动下载产物用JamesIves/github-pages-deploy-actionv4发布到 GitHub Pagessingle-commit: true并通过clean-exclude: pr-preview保留 PR 预览子目录工作流还配置了concurrency同一 PR 或同一提交的新构建会取消旧构建与权限声明contents: write用于推送 gh-pages 分支pull-requests: write用于在 PR 上张贴预览 URL。发布策略的完整语义是PR 阶段构建 预览main 分支/定时任务/手动触发时正式发布。八、本地构建与预览公告的最终产物是 Sphinx HTML可在本地先行构建验证。仓库使用 nox uv 管理文档构建pip install nox uv nox -s docs构建产物位于docs/build/html其中的announcements/*.html即各公告页面index.html即带搜索、标签与分页的公告落地页。新增或修改公告后在本地执行上述命令即可验证 RST 语法、卡片链接与图片引用是否正常再提交 PR 走完整流水线。九、小结Model Optimizer 的公告体系可以概括为一条内容即代码的链路内容侧公告以 Sphinx 页面形式存在于 docs/source/announcements/带:orphan:与 Author/Date/Tags 元数据可内嵌图片、公式与表格索引侧docs/source/index.rst 用announcement-card卡片承载data-date />赞分享【免费下载链接】Model-OptimizerA unified library of SOTA model optimization techniques like quantization, distillation, pruning, neural architecture search, speculative decoding, etc. It compresses deep learning models for downstream deployment frameworks like TensorRT-LLM, TensorRT, vLLM, etc. to optimize inference speed.项目地址https://gitcode.com/GitHub_Trending/te/Model-Optimizer点击查看免费下载相关推荐Presto Native Execution 文档系统基于 Sphinx 的构建与 GitHub Pages 发布指南Presto Native Execution 文档系统基于 Sphinx 的构建与 GitHub Pages 发布指南 Presto Native Exec大数据数据库后端psutil 文档站构建工程指南基于 Sphinx、ablog 与 GitHub Pages 的自托管文档体系psutil 文档站构建工程指南基于 Sphinx、ablog 与 GitHub Pages 的自托管文档体系 本文是一份关于 psutil 官方文档站发布可观测性系统编程OpenClaw 发布公告技能实战基于发布证据起草并发布 beta / stable / extended-stable 的 Discord 公告OpenClaw 发布公告技能实战基于发布证据起草并发布 beta / stable / extended stable 的 Discord 公告 导读 本文AI 应用AI Agent交互助手后端即时通讯网关创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
02
RELATED NEWS

相关资讯

更多网站建设与数字化升级内容

03
WHY YAOTU

想打造同款高转化官网?

懂行业、懂生意,从建站到增长一站式陪跑

◈

场景化定制

不做模板站,围绕你的业务场景量身设计,小众不撞款。

◐

营销型架构

以转化目标组织内容与路径,让官网真正带来询盘。

▲

全周期服务

设计、开发、运营、运维一体,上线只是开始。

免费获取你的建站方案

留下需求,专属顾问 24 小时内为你输出方案建议。