Skip to content

chore: use sphinx-tabs to show different installation commands #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CalMacCQ merged 2 commits into from
Jun 3, 2026
Merged

chore: use sphinx-tabs to show different installation commands #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22c7d05
start using sphinx-tabs extension
CalMacCQ Jun 3, 2026
b50f7fa
use tabs in installation subsection
CalMacCQ Jun 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ dependencies = [
"jupyter>=1.1.0",
"matplotlib>=3.9.2",
"networkx>=3.4.2",
"sphinx-tabs>=3.5.0",
"tket~=0.13.0",
]

Expand Down
1 change: 1 addition & 0 deletions sphinx/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
"sphinx.ext.autosectionlabel",
"sphinxcontrib.googleanalytics",
"quantinuum_sphinx",
"sphinx_tabs.tabs",
]
autosectionlabel_prefix_document = True

Expand Down
14 changes: 12 additions & 2 deletions sphinx/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,18 @@ kernelspec:

Guppy is installed as the [guppylang](https://pypi.org/project/guppylang/) Python package.

```shell
pip install guppylang


```{eval-rst}
.. tabs::

.. code-tab:: shell pip

pip install guppylang

.. code-tab:: shell uv

uv add guppylang
```

Guppy can be used with Python versions 3.10, 3.11, 3.12, 3.13 and 3.14. The MacOS, Linux and Windows operating systems are supported.
Expand Down
23 changes: 23 additions & 0 deletions uv.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading