How intel/quantum-sdk-docs works
1. This repository is not the Intel Quantum SDK runtime itself; it is the published documentation site for the SDK. The primary “product” here is a static HTML documentation corpus generated from source docs.
2. The top-level architectural boundary is between documentation source/material and generated output. The docs/ directory contains the rendered site, while docs/.doctrees/ and docs/.buildinfo are Sphinx build artifacts that capture parse state and incremental build metadata.
3. Two documentation systems are involved: Doxygen and Sphinx. README explicitly says the site was generated via both, which implies the repo aggregates API/reference material from code comments and narrative/user guides from Sphinx pages.
4. The site is organized into several major content domains:
- docs/api/ for API reference material
- docs/dgr/ for the DGR documentation set
- docs/fleq/ for the FLEQ documentation set
- docs/getting_started/ for onboarding and first-use guidance
- docs/tutorial/ for longer walkthroughs and examples
5. Within the DGR section, the pages map to the SDK’s quantum runtime/compiler concepts: circuits, gates, backends, compiler, native/OpenQASM support, full-state simulation, tensor network, MPI, Clifford, QEC, verification, and custom backend/user-pass extension points. This suggests DGR documentation covers a modular backend-and-compilation architecture.
6. Within the FLEQ section, the pages focus on the higher-level language and compilation model: DSL, branching, barriers, coherent transformations, data lists/quantum lists, conversion, higher-order constructs, and debugging. This indicates a separate abstraction layer for expressing quantum programs before lower-level compilation/execution.
7. The documentation structure shows a layered conceptual flow:
- introductory and getting-started material
- language/programming model docs
- compiler and backend docs
- specialized execution/simulation targets
- API reference
- tutorials and examples
This mirrors how a user would move from writing programs to understanding compilation and execution targets.
8. docs/index.html acts as the site root and navigation hub, with generated navigation/search support in docs/search.html, docs/searchindex.js, and docs/genindex.html. These are standard Sphinx outputs that provide cross-document discovery rather than application logic.
9. Presentation is handled by generated static assets under docs/_static/ plus the repository’s custom styling in assets/css/style.scss. The docs site therefore has a theming layer, but no application server or dynamic frontend backend.
10. The .doctrees subtree is an internal Sphinx cache of parsed pages for sections like DGR, FLEQ, getting started, and tutorial. It is important for rebuilds and dependency tracking, but not part of the published content model.
11. From an architecture diagram perspective, the only real “inputs” are the underlying documentation sources and generated API content; the only “outputs” are the static HTML pages and supporting assets. There are no runtime services, databases, or external APIs shown in this repository.
12. In short, the repo is a static documentation distribution with two major content tracks—DGR and FLEQ—plus API reference, onboarding, and tutorials, all assembled through a Sphinx/Doxygen publishing pipeline and served as prebuilt HTML.
Main entry points: docs/index.html Site root · dgr/index.html DGR docs · fleq/index.html FLEQ docs · README.md README
Components 20
Source material
Repository inputs and authored documentation content
Publishing pipeline
Doc generation and assembly steps
- Doxygen · Reference documentation source for code comments and API pages
- Sphinx · Narrative documentation builder and HTML publisher
- Build cache · Incremental build metadata and parsed document cache
docs/.buildinfo - Doctrees · Parsed page cache for section rebuilds and dependency tracking
docs/.doctrees
Published site
Prebuilt static HTML documentation and supporting assets
- Site root · Top-level landing page and navigation entry point
docs/index.html - Search index · Generated search and index support for navigation
docs/search.html - API docs · API reference section generated into the published site
docs/api/index.html - Getting started · Introductory guidance for first use and next steps
docs/getting_started/index.html - Tutorials · Long-form examples and guided exercises
docs/tutorial/index.html - DGR docs · Documentation for circuits, compiler, backends, and execution targets
docs/dgr/index.html - Compile path · Circuit, gates, compiler, native/OpenQASM, and output concepts
docs/dgr/compiler.html - Backends · Full-state, tensor network, MPI, Clifford, QEC, and verification targets
docs/dgr/backends.html - Extensions · Custom backend and user-pass extension mechanisms
docs/dgr/custom_backend.html - FLEQ docs · Documentation for the higher-level DSL and compilation model
docs/fleq/index.html - DSL model · DSL, branching, barriers, higher-order constructs, and debugging
docs/fleq/dsl.html - Data model · Data lists, quantum lists, conversion, and ordering rules
docs/fleq/datalist.html - Static assets · Generated CSS, JS, search tools, and theme resources
docs/_static - HTML sections · Rendered documentation pages across API, DGR, FLEQ, getting started, and tutorials
Connections 21
- README → Doxygen: describes · README states the site was generated with Doxygen
- README → Sphinx: describes · README states the site was generated with Sphinx
- Theme CSS → Static assets: themes · Custom styling is packaged into the published static assets
- Doxygen → API docs: builds · Doxygen feeds the API reference section
- Sphinx → HTML sections: renders · Sphinx produces the narrative documentation pages
- Sphinx → Build cache: tracks · Sphinx incremental build metadata is stored for rebuilds
- Sphinx → Doctrees: caches · Parsed document trees are cached for each documentation set
- Doctrees → HTML sections: supports · Doctrees support regeneration of the rendered site
- Build cache → HTML sections: supports · Build info supports incremental publishing
- API docs → Site root: navigates · API docs are part of the main site navigation
- Getting started → Site root: navigates · Getting started is a top-level section from the site root
- Tutorials → Site root: navigates · Tutorials are a top-level section from the site root
- DGR docs → Site root: navigates · DGR is a major documentation domain in the site hierarchy
- FLEQ docs → Site root: navigates · FLEQ is a major documentation domain in the site hierarchy
- DGR docs → Compile path: organizes · DGR content centers on circuit and compiler flow
- DGR docs → Backends: organizes · DGR content covers execution and simulation backends
- DGR docs → Extensions: organizes · DGR content includes extension and customization points
- FLEQ docs → DSL model: organizes · FLEQ content focuses on the language and control-flow model
- FLEQ docs → Data model: organizes · FLEQ content explains program data structures and conversion
- Static assets → Site root: serves · Static theme assets support the rendered site pages
- Search index → Site root: indexes · Search and genindex provide cross-document discovery from the site root