Update doc layout - #760
Open
melody-ren wants to merge 16 commits into
Open
Conversation
Bring the index captions (Libraries -> components/qec/index, new Performance Studies section), the introduction->index redirect and navigation_depth, and the single-column genindex CSS. Content pages follow in subsequent commits. Signed-off-by: Melody Ren <melodyr@nvidia.com>
Replace the monolithic introduction.rst with the release's component structure (index, codes, decoders, realtime_decoding, numerical_experiments, conventions). These already incorporate main's substantive additions (surface-code orientation, DEM sampling, sliding-window num_boundary_syndromes), so they carry main's concept content in the release layout. Example pages are reorganized in following commits. Signed-off-by: Melody Ren <melodyr@nvidia.com>
Relocate main's nv_qldpc_gamma_ensemble_user_guide.rst under performance/ with the release's landing page and See Also links (fixing image paths for the new depth). Figures are already LFS-tracked on main. Signed-off-by: Melody Ren <melodyr@nvidia.com>
Merge code-capacity/circuit-level into Experiments and Noise Modeling and stim-dem/dem-sampling into Decoders, split Realtime Decoding into a lean index plus Getting Started, and add Creating New QEC Codes -- all carrying main's content. Main's realtime leaf pages (predecoders, relay BP) are kept as-is since they diverge from the release; only the toctree/linkage is updated. Signed-off-by: Melody Ren <melodyr@nvidia.com>
Preserve the previously published URLs for code_capacity_noise, circuit_level_noise, stim_dem_decoder, dem_sampling (now under Experiments and Noise Modeling / Decoders) and the gamma-ensemble page (now under performance/). Signed-off-by: Melody Ren <melodyr@nvidia.com>
Rename Real-Time -> Realtime, add the scipy.sparse and syndrome-measurement-layout notes, fix the chromobius Mobius->Möbius typo and the tensor-network qldpc link. Main's api symbols (DecoderDispatch, transport structs, etc.) are preserved. Signed-off-by: Melody Ren <melodyr@nvidia.com>
Main ships the decoding server, so the Realtime Enabled column is meaningful; restore it (dropped on the release branch). Signed-off-by: Melody Ren <melodyr@nvidia.com>
Add a See Also (Realtime Decoding concept, Getting Started, realtime API) to the relay-BP and predecoder pages, and give the pymatching Data Directory Layout an explicit label/ref. Build content (pins, paths, flags) stays as main's. Signed-off-by: Melody Ren <melodyr@nvidia.com>
Move the cpp/python realtime-decoding API labels onto their headings so :ref: lands on the header instead of the line below, and repoint the realtime example source link from releases/v0.7.0 to main. Signed-off-by: Melody Ren <melodyr@nvidia.com>
The Documentation workflow checked out without lfs, so the gamma-ensemble figures were published as LFS pointer files instead of real PNGs. Add lfs: true to the checkout so the images are smudged before the Sphinx build. Signed-off-by: Melody Ren <melodyr@nvidia.com>
Bring in main's realtime_decoding_demo (NVIDIA#703 -- driving the delivered decoding server from a QPU kernel or FPGA) and its code directory, wired into our Realtime Decoding toctree rather than main's flat examples list. Signed-off-by: Melody Ren <melodyr@nvidia.com>
Adds versioning support to our docs. When docs are deployed, they are saved to the `gh-pages` branch. Then the contents of that branch are deployed. Also adds a version switcher element to the docs. --------- Signed-off-by: Angela Burton <angelab@nvidia.com> (cherry picked from commit 6eee145) Signed-off-by: Melody Ren <melodyr@nvidia.com>
…c_layout # Conflicts: # docs/sphinx/examples_rst/qec/examples.rst
melody-ren
marked this pull request as ready for review
August 4, 2026 15:05
Collaborator
Author
|
@vedika-saravanan I did try to make sure that I used main branch's content when I applied the new doc layout. Could you please double check to make sure that I didn't bring in content meant for the release branch (the fixes you put in etc) in here? Thanks! |
eliotheinrich
left a comment
eliotheinrich
left a comment
Collaborator
There was a problem hiding this comment.
I found two small issues with the rendering, but otherwise looks great!
…e for two-qubit state Signed-off-by: Melody Ren <melodyr@nvidia.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Porting the doc layout update into the main branch. Using the main branch's doc content but adopting releases/v0.7.0 doc's layout. Links are preserved or forwarded