Skip to content

Introducing the pyqpanda3 Documentation System

Origin Quantum Teamdocsplatform

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 | |

Released under the MIT License.