Skip to content

pyqpanda3 文档系统正式上线

我们很高兴地宣布 pyqpanda3 文档平台 正式上线 —— 这是一个面向开发者设计的综合性文档站点,旨在帮助你充分发挥 pyqpanda3 量子计算 SDK 的能力。

基于 VitePress 构建 ​

文档站点基于 VitePress 1.6.3 构建,这是一个专为技术文档优化的静态站点生成器。它提供快速的页面加载、简洁的 URL 以及开箱即用的 SEO 优化。

双语支持 ​

整个文档提供 英文 和 中文(简体中文) 两个版本。每个页面 —— 教程、API 参考、博客文章和发布说明 —— 均使用两种语言维护。使用导航栏中的语言切换按钮即可切换。

自定义工业风主题 ​

我们设计了反映专业工业美学的自定义主题:

  • 暗色优先 的外观,支持亮色模式切换
  • 自定义导航栏 替代 VitePress 默认导航,支持下拉菜单、语言切换和暗色模式切换
  • 自托管字体 — 标题使用 Oswald、正文使用 IBM Plex Sans、代码使用 IBM Plex Mono — 预加载以实现零 CLS
  • 自定义页脚 包含品牌信息和社交链接
  • 响应式设计 — 移动端全功能汉堡菜单,带滑入式面板

全文搜索与中文分词支持 ​

我们使用 Pagefind 作为搜索引擎,在构建时生成静态搜索索引,实现即时搜索结果。对于中文内容,我们集成了 Intl.Segmenter 来正确分词 —— 无需任何外部依赖。

文档结构 ​

站点分为四个主要板块:

教程 ​

分步指南,涵盖量子基础、线路构建、态制备、仿真、噪声建模、变分线路、线路转换、可视化和云计算。

操作指南 ​

常见量子计算任务的实用方案 —— Bell 态、GHZ 态、量子隐形传态、Grover 搜索、VQE、QAOA、自定义量子门等。

API 参考 ​

按模块组织的全面 API 文档:

模块说明
核心模块量子线路、量子门、测量、仿真器、噪声
哈密顿量泡利算符、泡利项、哈密顿量构建
量子云云服务、任务管理、结果获取
量子信息态矢量、密度矩阵、酉矩阵
线路转换分解、拓扑结构、转换器
可视化Bloch 球、量子态图、线路图
变分线路变分量子线路、梯度、参数

概念 ​

量子计算理论的深入讲解 —— 门理论、信息理论、噪声模型、线路转换和变分算法。

Mermaid 图表 ​

文档支持 Mermaid 图表,用于可视化工作流、架构和量子线路。图表自动适配暗色和亮色模式的文字颜色。

数学公式 ​

技术内容通过 markdown-it-mathjax3 渲染 LaTeX 数学公式,支持行内公式($E = mc^2$)和块级公式:

⟨ψ|H|ψ⟩

博客与发布说明 ​

站点包含 博客系统,支持自动索引和摘要,以及 版本发布说明,详细记录每次 pyqpanda3 更新,附带完整变更日志和代码示例。

后续计划 ​

我们正在持续改进文档:

  • 扩展 API 参考覆盖范围
  • 添加更多交互式示例
  • 优化技术术语的搜索相关性
  • 增加更多高级主题的教程内容

访问文档站点 qpanda3-docs.vercel.app,欢迎提出你的建议!

Released under the MIT License.