Skip to content

Update doc-live branch to include latest documentation changes#124

Merged
nelimee merged 26 commits into
docs-livefrom
main
Nov 5, 2025
Merged

Update doc-live branch to include latest documentation changes#124
nelimee merged 26 commits into
docs-livefrom
main

Conversation

@nelimee

@nelimee nelimee commented Nov 5, 2025

Copy link
Copy Markdown
Collaborator

No description provided.

zhiyaol and others added 26 commits October 2, 2025 15:11
---------

Co-authored-by: Guen Prawiroatmodjo <4041805+guenp@users.noreply.github.com>
…tom build command (#86)

---------

Co-authored-by: Guen Prawiroatmodjo <4041805+guenp@users.noreply.github.com>
* chore: configure ruff format to format appropriate folders

* chore: run ruff format in pre-commit

* chore: run ruff format

* ci: run ruff format --check in CI

* Change loop parameter naming for clearer format

* MAINT: updates to fix typos, end-of-line whitespace

* ruff format
* docs: amend pixi setup instruction

* docs: adjustment
* docs: links should point to latest stable docs

* Update index.rst

* Update README.md

* Apply suggestions from code review

Co-authored-by: Guen Prawiroatmodjo <4041805+guenp@users.noreply.github.com>
---------

Co-authored-by: Guen Prawiroatmodjo <4041805+guenp@users.noreply.github.com>
* chore: allow mypy to run from top level

* chore: fix whitespace

* dev: run mypy . in CI

* chore: adjust mypy.ini to make mypy happy

* dev: add mypy to pre-commit

* dev: add scipy-stubs
* tests: allow pytest to run from top level

* chore: remove unnecessary __init__.py files in test folders
* DEV: add upper bound on supported Python

* Update pyproject.toml

* Update .github/workflows/docs.yml

* Update .github/workflows/docs.yml

* Update .github/workflows/static_code_analysis.yml

* CI: no need to install Python before pixi?

* CI: remove unnecessary upper bound?

* CI: remove unnecessary upper bound?

* CI: update setup-pixi and pixi versions

* CI: don't set up Python if not required

* CI: avoid unnecessary command?

* CI: no need for Python on RTD?

* CI: check one last time that we need this constraint

* Revert "CI: check one last time that we need this constraint"
* Fixed token setting tests by changing 403 to 401

* Remove Whitespace

* Added Requested Comment

* Removed unnecessary file
* dev: add conda environment.yml

* dev: add poetry dependencies

* docs: add hatch support

* dev: add uv support

* docs: document alternative package managers

* Revert "docs: document alternative package managers"

This reverts commit f9a3a06.

* Revert "dev: add uv support"

This reverts commit f966fe4.

* Revert "docs: add hatch support"

This reverts commit a940ead.

* Revert "Revert "docs: add hatch support""

This reverts commit b9d5178.

* Revert "Revert "docs: document alternative package managers""

This reverts commit 3417f0b.

* docs: fix dropdown/tabs

* dev: remove pixi-pycharm from environment.yml

* dev: add uv support

* dev: make uv install component packages as editable

* dev: make hatch install component packages as editable

* chore: ensure Python <3.14 for conda and poetry

* docs: add whitespace

---------

Co-authored-by: Adrien Suau <12374487+nelimee@users.noreply.github.com>
* chore: add en-gb locale to typos

* favorite -> favourite

* artifact -> artefact

* Allow Authorization due to its use for web-related fields

* Exclude any license from typos check

* Fix "depolarization" and ignore "color"

* Fix remaining typos

* neighbours -> neighbors for property

* Fix tests

---------

Co-authored-by: Adrien Suau <12374487+nelimee@users.noreply.github.com>
* Add tag to annotations

* Add tag to gates

* Fix circuit tests

* Add tag to noise instructions

* Add missing tag in __repr__

* Allow exporting tags to stim circuit

* Testing tags

* Add default value to tag in stim identifiers

* Make QPU.add_noise_to_circuit publicly accessible

* Remove commented out lines
Co-authored-by: Marco Ghibaudi <62563515+mghibaudi@users.noreply.github.com>
…r round' (#108)

* docs: replace 'logical error rate' with 'logical error probability per round'

* Apply suggestions from code review

* LER => LEP

* Fix test

* Fix documentation

---------

Co-authored-by: Adrien Suau <12374487+nelimee@users.noreply.github.com>
* Un-ignore deprecation warnings in tests

* Ignore specific warning

---------

Co-authored-by: Marco Ghibaudi <62563515+mghibaudi@users.noreply.github.com>
* Un-ignore deprecation warnings in tests

* Ignore specific warning

* Add deprecation function

* Adding pragma: no cover for overloads

* Fix deprecated error reporting

* Allow deprecated to be called with all-None values

* Adding tests to deprecated
@nelimee nelimee self-assigned this Nov 5, 2025
@nelimee nelimee added the documentation Improvements or additions to documentation label Nov 5, 2025
@nelimee
nelimee requested a review from oc251 as a code owner November 5, 2025 10:47
@github-actions github-actions Bot added deltakit-explorer deltakit-circuit deltakit-core deltakit-decode dev Changes that affect development tools/configuration (e.g. pixi, sphinx, pytest, mypy, ruff, CI) labels Nov 5, 2025
@nelimee

nelimee commented Nov 5, 2025

Copy link
Copy Markdown
Collaborator Author

CI failure is "expected". Currently waiting for a new release of the bposd package we can depend on that includes quantumgizmos/bp_osd#19.

Merging to update the live documentation on https://deltakit-docs.riverlane.com/en/docs/.

@nelimee
nelimee merged commit e928da8 into docs-live Nov 5, 2025
53 of 57 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

deltakit-circuit deltakit-core deltakit-decode deltakit-explorer dev Changes that affect development tools/configuration (e.g. pixi, sphinx, pytest, mypy, ruff, CI) documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants