We're excited to announce the new pyqpanda3 documentation platform — a comprehensive, developer-friendly documentation site designed to help you get the most out of the pyqpanda3 quantum computing SDK.
Built on VitePress
The documentation site is built on VitePress 1.6.3, a static site generator optimized for technical documentation. It delivers fast page loads, clean URLs, and excellent SEO out of the box.
Bilingual Support
The entire documentation is available in both English and Chinese (简体中文). Every page — tutorials, API references, blog posts, and release notes — is maintained in both languages. Switch between languages using the language toggle in the navigation bar.
Custom Industrial Design Theme
We've designed a custom theme that reflects a professional, industrial aesthetic:
- Dark-first appearance with light mode toggle
- Custom navigation bar replacing the VitePress default, with dropdown menus, language switcher, and dark mode toggle
- Self-hosted fonts — Oswald for headings, IBM Plex Sans for body text, IBM Plex Mono for code — preloaded for zero CLS
- Custom footer with branding and social links
- Responsive design — full hamburger menu on mobile with slide-in panel
Full-Text Search with Chinese Support
We use Pagefind as our search engine, which builds a static search index at build time for instant results. For Chinese content, we integrate Intl.Segmenter to properly segment Chinese text into searchable tokens — no external dependencies required.
Documentation Structure
The site is organized into four main sections:
Tutorials
Step-by-step guides covering quantum basics, circuit construction, state preparation, simulation, noise modeling, variational circuits, transpilation, visualization, and cloud computing.
How-To Guides
Practical recipes for common quantum computing tasks — Bell states, GHZ states, quantum teleportation, Grover search, VQE, QAOA, custom gates, and more.
API Reference
Comprehensive API documentation organized by module:
| Module | Description |
|---|---|
| Core | Circuit, gates, measurement, simulator, noise |
| Hamiltonian | Pauli operators, Pauli terms, Hamiltonian construction |
| QCloud | Cloud service, job management, results |
| Quantum Info | State vectors, density matrices, unitary matrices |
| Transpilation | Decomposition, topology, transpiler |
| Visualization | Bloch spheres, state plots, circuit diagrams |
| VQCircuit | Variational circuits, gradients, parameters |
Concepts
In-depth explanations of quantum computing theory — gate theory, information theory, noise models, transpilation, and variational algorithms.
Mermaid Diagrams
The documentation supports Mermaid diagrams for visualizing workflows, architectures, and quantum circuits. Diagrams automatically adapt their text colors for both dark and light modes.
Mathematical Notation
Technical content renders LaTeX math notation via markdown-it-mathjax3, supporting both inline ($E = mc^2$) and block equations:
Blog & Release Notes
The site includes a blog system with automatic indexing and excerpts, and versioned release notes tracking every pyqpanda3 update with detailed changelogs and code examples.
What's Next
We're continuously improving the documentation:
- Expanding API reference coverage
- Adding more interactive examples
- Improving search relevance for technical terms
- Adding more tutorial content for advanced topics
Visit the documentation at qpanda3-docs.vercel.app and let us know what you think!