Skip to content

Commit

Permalink
SC80682 | fix deprecation issues (#89)
Browse files Browse the repository at this point in the history
**Context:**

https://app.shortcut.com/xanaduai/story/80682/fix-deprecation-issues-with-pennylane-sphinx-theme

**Description of the Change:**
- Update `name` to comply with [PEP
625](https://peps.python.org/pep-0625/)
- Update year in footer

**Benefits:**
- Resolves deprecation warnings from Pypi
- The correct year is shown in the footer

**Possible Drawbacks:**
NA

**Related GitHub Issues:**
NA
  • Loading branch information
AndrewGardhouse authored Jan 21, 2025
1 parent e3f2440 commit 67b67d2
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 6 deletions.
10 changes: 9 additions & 1 deletion .github/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
## Release 0.10.0 (development release)
## Release 0.10.0

### Contributors

This release contains contributions from (in alphabetical order):

- [Andrew Gardhouse](https://github.com/AndrewGardhouse)

### Features

- Update `name` in `setup.py` so the build does not use `-` in the name. This is to comply with [PEP 625](https://peps.python.org/pep-0625/), which is causing deprication warnings from PyPI
- Update year in footer
- Disable hotkeys in theme

## Release 0.9.0

### Contributors
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/upload.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install --upgrade pip setuptools
pip install -r requirements-dev.txt
- name: Install the Xanadu Sphinx Theme
Expand Down
6 changes: 4 additions & 2 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,12 @@
# sys.path.insert(0, os.path.abspath('.'))

import re
from datetime import datetime

# -- Project information -----------------------------------------------------

project = 'PennyLane Sphinx Theme'
copyright = '2023 | Xanadu | All rights reserved'
copyright = f"{datetime.now().year} | Xanadu | All rights reserved"
author = 'Xanadu Inc.'

# The version info for the project you're documenting, acts as replacement for
Expand Down Expand Up @@ -101,7 +102,8 @@
"toc_global": True,
"relations": True,
"command_palette_enabled": False,
"search_on_pennylane_ai": False
"search_on_pennylane_ai": False,
"hotkeys": False
}


Expand Down
2 changes: 1 addition & 1 deletion doc/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ sphinxcontrib-htmlhelp==2.0.1
sphinxcontrib-serializinghtml==1.1.5
sphinx-copybutton
sphinx-gallery==0.10.1
xanadu-sphinx-theme==0.7.0
xanadu-sphinx-theme==0.8.0
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
sphinx==4.5.0
pillow==10.3.0
sphinx-gallery==0.10.1
xanadu-sphinx-theme==0.7.0
xanadu-sphinx-theme==0.8.0
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

requirements = [
"sphinx",
"xanadu-sphinx-theme~=0.7.0",
"xanadu-sphinx-theme~=0.8.0",
# The packages below are used to generate thumbnail images.
"pillow",
"sphinx-gallery",
Expand Down

0 comments on commit 67b67d2

Please sign in to comment.