Skip to content

Commit 4c201d8

Browse files
ryanhill1ryanhill1
authored
format + docs logo + v2 links (#289)
* format + docs logo + links * Update CHANGELOG and pyproject.toml to reflect new logo, added Python 3.14 support, and minor formatting fixes. * update logo dimensions + padding
1 parent 22681a7 commit 4c201d8

54 files changed

Lines changed: 105 additions & 306 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/logo-check.yml‎

Lines changed: 0 additions & 73 deletions
This file was deleted.

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Types of changes:
1919
### Improved / Modified
2020
- Moved the `visit_map` from the `visit_statement` function to a class level variable for improved efficiency. ([#279](https://github.com/qBraid/pyqasm/pull/279))
2121
- Added SVG light and dark mode versions of PyQASM logo, with and without text, and added dynamic logo mode to `README.md` based on color palette used on user-side. ([#288](https://github.com/qBraid/pyqasm/pull/288))
22+
- Updated docs with new logo, added v2 links, and applied minor Python formatting fixes for style consistency. ([#289](https://github.com/qBraid/pyqasm/pull/289))
2223

2324
### Deprecated
2425

‎README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# pyqasm
2-
31
<p align="left">
42
<img src="docs/_static/pyqasm-light.svg#gh-light-mode-only" width="500" alt="PyQASM Logo (Light Mode)">
53
<img src="docs/_static/pyqasm-dark.svg#gh-dark-mode-only" width="500" alt="PyQASM Logo (Dark Mode)">
@@ -15,7 +13,9 @@
1513

1614
Python toolkit providing an OpenQASM 3 semantic analyzer and utilities for program analysis and compilation.
1715

18-
[![Env Badge](https://img.shields.io/endpoint?url=https://api.qbraid.com/api/environments/valid?envSlug=pyqasm_l9qauu&label=Launch+on+qBraid&labelColor=lightgrey&logo=rocket&logoSize=auto&style=for-the-badge)](http://account.qbraid.com?gitHubUrl=https://github.com/qBraid/pyqasm.git&envId=pyqasm_l9qauu)
16+
<!--
17+
[![Env Badge](https://img.shields.io/endpoint?url=https://api.qbraid.com/api/environments/valid?envSlug=pyqasm_l9qauu&label=Launch+on+qBraid&labelColor=lightgrey&logo=rocket&logoSize=auto&style=for-the-badge)](https://account.qbraid.com/explore/projects/pyqasm)
18+
-->
1919

2020
## Motivation
2121
[OpenQASM](https://openqasm.com/) is a powerful language for expressing hybrid quantum-classical programs, but it lacks a comprehensive tool supporting the _full capabilities of the language_. PyQASM aims to fill this gap by building upon the [`openqasm3.parser`](https://github.com/openqasm/openqasm/blob/ast-py/v1.0.1/source/openqasm/openqasm3/parser.py), and providing support for semantic analysis and utilities for program compilation.
@@ -85,10 +85,10 @@ PyQASM offers robust support for the **extensive grammar of OpenQASM 3**, includ
8585
- Quantum-classical interaction (`measurement`, `reset`, etc.)
8686
- Inclusion of standard libraries (`stdgates.inc`, etc.)
8787

88-
- **[Unrolling](https://docs.qbraid.com/pyqasm/user-guide/examples#inlining-%26-unrolling):**
88+
- **[Unrolling](https://docs.qbraid.com/v2/pyqasm/user-guide/examples#inlining-%26-unrolling):**
8989
Expands all custom gates, loops, subroutines, branches, etc. into a flat, hardware-ready sequence of instructions.
9090

91-
- **[Validation](https://docs.qbraid.com/pyqasm/user-guide/overview#the-qasmmodule-object):**
91+
- **[Validation](https://docs.qbraid.com/v2/pyqasm/user-guide/overview#the-qasmmodule-object):**
9292
Performs semantic analysis to ensure programs are correct and conform to the OpenQASM 3 specification.
9393

9494
---

‎bin/bump_version.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
Script to bump the major, minor, or patch version in pyproject.toml.
1717
1818
"""
19+
1920
import pathlib
2021
import sys
2122

‎bin/stamp_pre_release.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
Script for getting/bumping the next pre-release version.
1717
1818
"""
19+
1920
import pathlib
2021
import sys
2122

‎docs/_static/pyqasm.svg‎

Lines changed: 0 additions & 136 deletions
This file was deleted.

‎docs/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
# -- Project information -----------------------------------------------------
1616

1717
project = "qBraid"
18-
copyright = "2025, qBraid Development Team"
18+
copyright = "2026, qBraid Development Team"
1919
author = "qBraid Development Team"
2020

2121
# The full version, including alpha/beta/rc tags

‎docs/index.rst‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,11 @@
4545
</style>
4646
</head>
4747
<body>
48-
<h1 style="text-align: center">
49-
<img src="_static/pyqasm.svg" alt="pyqasm logo" style="width:60px;height:60px;">
50-
<span style="color:#808080"> PyQASM</span>
48+
<h1 style="text-align: center; margin-top: 0; margin-bottom: 0.25em; padding-top: 0.5em; padding-bottom: 0.5em">
49+
<img src="_static/pyqasm-light.svg" alt="pyqasm logo" style="width:280px;height:auto;max-width:min(280px, 50vw);">
5150
</h1>
52-
<p style="text-align:center;font-style:italic;color:#808080">
53-
Python toolkit for OpenQASM program analysis and compilation.
51+
<p style="text-align:center;font-style:italic;color:#808080; margin-top: 0; margin-bottom: 0.5em">
52+
Python toolkit for OpenQASM program analysis and compilation.
5453
</p>
5554
</body>
5655
</html>
@@ -154,7 +153,7 @@ Example
154153
Resources
155154
----------
156155

157-
- `User Guide <https://docs.qbraid.com/pyqasm/user-guide>`_
156+
- `User Guide <https://docs.qbraid.com/v2/pyqasm/user-guide>`_
158157
- `Example Usage <https://github.com/qBraid/pyqasm/tree/main/examples>`_
159158
- `Source Code <https://github.com/qBraid/pyqasm>`_
160159

@@ -193,3 +192,9 @@ Resources
193192
:hidden:
194193

195194
api/pyqasm
195+
196+
.. toctree::
197+
:caption: ALGOS API Reference
198+
:hidden:
199+
200+
qbraid_algorithms <https://qbraid.github.io/qbraid-algorithms/api/qbraid_algorithms.html>

‎pyproject.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ classifiers = [
2222
"Programming Language :: Python :: 3.11",
2323
"Programming Language :: Python :: 3.12",
2424
"Programming Language :: Python :: 3.13",
25+
"Programming Language :: Python :: 3.14",
2526
"Programming Language :: Python :: 3 :: Only",
2627
"Topic :: Software Development",
2728
"Topic :: Scientific/Engineering",

‎src/pyqasm/__init__.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@
5151
QasmParsingError
5252
5353
"""
54+
5455
import warnings
5556
from importlib.metadata import version
5657

0 commit comments

Comments
 (0)