Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/cqcl/guppy-docs

Documentation for the Guppy programming language

https://github.com/cqcl/guppy-docs

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.1%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

Documentation for the Guppy programming language

Basic Info
  • Host: GitHub
  • Owner: CQCL
  • Language: Markdown
  • Default Branch: main
  • Homepage: https://guppylang.org
  • Size: 1.1 MB
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 2
  • Releases: 0
Created 10 months ago · Last pushed 10 months ago
Metadata Files
Readme

README.md

Guppy Documentation

This repository contains documentation for the Guppy programming language.

Contents

  • The Guppy language guide
  • The Guppy landing page
  • The API documentation for the guppylang package
  • FAQs, changelog and migration guides
  • The guppylang example notebooks (included via the guppylang submodule)

The Sphinx docs are written in MyST markdown and rendered with the myst-nb library. This variant of markdown supports code cells which are executed at docs build time. See the section on text-based notebooks. The docs are styled with the quantinuum-sphinx theme.

For information on how the landing page is built, see the landing page README.

Testing in C.I.

The following checks are run when a pull request is opened.

  • Spell checking - spell checking is done using the typos crate.
  • The sphinx docs build is tested. This includes all code snippets and example notebooks. If a code snippet throws an error, this will fail the docs build.
  • Link checking (using the sphinx-linkcheck builder) - All links in the sphinx directory are tested. Broken links will cause the C.I. checks to fail.
  • (currently disabled) Sphinx coverage checks using sphinx.ext.coverage - check that all of the public guppylang API is documented.

Building the docs locally

Requirements: * The just command runner * Sphinx docs -> uv

See the devenv.nix file.

First clone the repository making sure to checkout the guppylang submodule.

shell git clone git@github.com:CQCL/guppy-docs.git --recurse-submodules

Alternatively you can update the submodules if you have already cloned the repository.

shell git submodule update --init Next run the build with just build. This builds both the Sphinx docs and the landing page

shell just build

The built html page can be served locally with:

shell just serve

To clean all of the files generated by the sphinx build:

shell just cleanup

To run the build in "debug" mode:

shell just build-debug

Followed by

shell just serve-debug

Building the docs in debug mode with just build-debug allows sphinx warnings whereas just build treats these warnings as errors. Debug mode is useful for debugging issues with the executed Guppy code in the docs.

To check the API docs coverage run:

shell just coverage

To check all of the links in the Sphinx docs run:

shell just link-check

Owner

  • Name: Cambridge Quantum
  • Login: CQCL
  • Kind: organization
  • Location: Cambridge, UK

Quantum Software and Technologies

GitHub Events

Total
  • Issues event: 1
  • Delete event: 1
  • Push event: 4
  • Pull request review event: 1
  • Pull request event: 3
  • Create event: 2
Last Year
  • Issues event: 1
  • Delete event: 1
  • Push event: 4
  • Pull request review event: 1
  • Pull request event: 3
  • Create event: 2

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 1
  • Total pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 hour
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.5
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 hour
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.5
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • CalMacCQ (1)
Pull Request Authors
  • CalMacCQ (2)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/add-to-project.yml actions
.github/workflows/docs.yml actions
  • actions/checkout v4 composite
  • actions/setup-node v4 composite
  • astral-sh/setup-uv v5 composite
  • extractions/setup-just v3 composite
.github/workflows/drop-cache.yml actions
.github/workflows/pr-title.yml actions
.github/workflows/typos.yml actions
  • actions/checkout v4 composite
  • crate-ci/typos v1.32.0 composite
landing/package-lock.json npm
  • 689 dependencies
landing/package.json npm
  • @eslint/eslintrc ^3 development
  • @tailwindcss/postcss ^4 development
  • @trivago/prettier-plugin-sort-imports ^5.2.2 development
  • @types/node ^20 development
  • @types/react ^18 development
  • @types/react-dom ^18 development
  • eslint ^8 development
  • eslint-config-next 14.2.7 development
  • prettier-plugin-tailwindcss ^0.6.14 development
  • tailwindcss ^3.4.1 development
  • typescript ^5 development
  • @cqcl/quantinuum-ui ^1.24.3
  • @next/third-parties ^15.4.6
  • @quantinuum/quantinuum-ui ^2.4.0
  • lucide-react ^0.539.0
  • next ^14.2.0
  • react ^18.0.0
  • react-dom ^18.0.0
  • shiki ^3.9.2
  • turbopack ^0.0.1
  • zod ^3.23.8
pyproject.toml pypi
  • guppylang ~=0.21.3
  • jupyter >=1.1.0
  • matplotlib >=3.9.2
  • networkx >=3.4.2
  • tket ~=0.12.1
uv.lock pypi
  • 180 dependencies