Skip to content

Commit a1f2b76

Browse files
jontoyejontoye
authored
update navbar and footer links (#140)
**Context:** https://app.shortcut.com/xanaduai/story/96334/update-cms-files-in-docs-site-with-new-navigation-copy **Description of the Change:** - Updates the navbar and footer links and labels - The old twitter logo is replaced with the new twitter-x logo which required an update from v2 to v3 of boxicons in [xanadu-sphinx-theme](XanaduAI/xanadu-sphinx-theme#93) **Benefits:** - Improves clarity and usability by providing more descriptive and intuitive labels for each link in the navbar and footer, making navigation easier for users **Possible Drawbacks:** - Confusion for users who are used to the old layout/links **Related GitHub Issues:**
1 parent 2dafcd6 commit a1f2b76

File tree

6 files changed

+128
-142
lines changed

6 files changed

+128
-142
lines changed

‎.github/CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ This release contains contributions from (in alphabetical order):
99
### Contributors
1010

1111
This release contains contributions from (in alphabetical order):
12+
- [Jon Toye](https://github.com/jontoye)
13+
14+
### Features
15+
16+
- Updates the navbar and footer links and labels
17+
- Replaces the old Twitter logo with the new Twitter-X logo and updates all icon references to use Boxicons v3 instead of v2 for compatibility with [xanadu-sphinx-theme update](https://github.com/XanaduAI/xanadu-sphinx-theme/pull/93)
1218

1319
## Release 0.21.0
1420

‎doc/requirements.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ sphinxcontrib-htmlhelp==2.0.1
1111
sphinxcontrib-serializinghtml==1.1.5
1212
sphinx-copybutton
1313
sphinx-gallery==0.10.1
14-
xanadu-sphinx-theme==0.14.0
14+
xanadu-sphinx-theme==0.15.0

‎pennylane_sphinx_theme/footer.py‎

Lines changed: 52 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
"title": "PennyLane",
88
"icon": "https://assets.cloud.pennylane.ai/docs/pennylane-logo.png",
99
"description": """\
10-
PennyLane is an open-source software framework for quantum
11-
machine learning, quantum chemistry, and quantum computing,
12-
with the ability to run on all hardware. Built with ❤️ by
10+
PennyLane is a cross-platform Python library for quantum computing,
11+
quantum machine learning, and quantum chemistry. Built by researchers,
12+
for research. Created with ❤️ by
1313
<a href="https://xanadu.ai">Xanadu</a>.
1414
""",
1515
},
@@ -33,53 +33,41 @@
3333
],
3434
"footer_links": [
3535
{
36-
"title": "For researchers",
36+
"title": "Research",
3737
"links": [
3838
{
3939
"name": "Research",
4040
"href": "https://pennylane.ai/research",
4141
},
42-
{
43-
"name": "Features",
44-
"href": "https://pennylane.ai/features",
45-
},
46-
{
47-
"name": "Demos",
48-
"href": "https://pennylane.ai/qml/demonstrations",
49-
},
50-
{
51-
"name": "Compilation",
52-
"href": "https://pennylane.ai/compilation",
53-
},
54-
{
55-
"name": "Datasets",
56-
"href": "https://pennylane.ai/datasets",
57-
},
5842
{
5943
"name": "Performance",
6044
"href": "https://pennylane.ai/performance",
6145
},
6246
{
63-
"name": "Learn",
64-
"href": "https://pennylane.ai/qml",
47+
"name": "Hardware & Simulators",
48+
"href": "https://pennylane.ai/devices",
6549
},
6650
{
67-
"name": "Videos",
68-
"href": "https://pennylane.ai/qml/videos",
51+
"name": "Demos",
52+
"href": "https://pennylane.ai/qml/demonstrations",
6953
},
7054
{
71-
"name": "Documentation",
72-
"href": "https://docs.pennylane.ai/",
55+
"name": "Quantum Compilation",
56+
"href": "https://pennylane.ai/compilation",
7357
},
7458
{
75-
"name": "Teach",
76-
"href": "https://pennylane.ai/education",
59+
"name": "Quantum Datasets",
60+
"href": "https://pennylane.ai/datasets",
7761
},
7862
],
7963
},
8064
{
81-
"title": "For learners",
65+
"title": "Education",
8266
"links": [
67+
{
68+
"name": "Teach",
69+
"href": "https://pennylane.ai/education",
70+
},
8371
{
8472
"name": "Learn",
8573
"href": "https://pennylane.ai/qml",
@@ -89,34 +77,26 @@
8977
"href": "https://pennylane.ai/codebook",
9078
},
9179
{
92-
"name": "Teach",
93-
"href": "https://pennylane.ai/education",
80+
"name": "Coding Challenges",
81+
"href": "https://pennylane.ai/challenges",
9482
},
9583
{
9684
"name": "Videos",
9785
"href": "https://pennylane.ai/qml/videos",
9886
},
99-
{
100-
"name": "Challenges",
101-
"href": "https://pennylane.ai/challenges",
102-
},
103-
{
104-
"name": "Demos",
105-
"href": "https://pennylane.ai/qml/demonstrations",
106-
},
107-
{
108-
"name": "Compilation",
109-
"href": "https://pennylane.ai/compilation",
110-
},
11187
{
11288
"name": "Glossary",
11389
"href": "https://pennylane.ai/qml/glossary",
11490
},
11591
],
11692
},
11793
{
118-
"title": "For developers",
94+
"title": "Software",
11995
"links": [
96+
{
97+
"name": "Install PennyLane",
98+
"href": "https://pennylane.ai/install",
99+
},
120100
{
121101
"name": "Features",
122102
"href": "https://pennylane.ai/features",
@@ -126,75 +106,60 @@
126106
"href": "https://docs.pennylane.ai",
127107
},
128108
{
129-
"name": "API",
130-
"href": "https://docs.pennylane.ai/en/stable/code/qml.html",
131-
},
132-
{
133-
"name": "GitHub",
134-
"href": "https://github.com/PennyLaneAI/pennylane",
109+
"name": "Catalyst Compilation Docs",
110+
"href": "https://docs.pennylane.ai/projects/catalyst/en/stable/",
135111
},
136112
{
137-
"name": "Datasets",
138-
"href": "https://pennylane.ai/datasets",
139-
},
140-
{
141-
"name": "Demos",
142-
"href": "https://pennylane.ai/qml/demonstrations",
113+
"name": "Development Guide",
114+
"href": "https://docs.pennylane.ai/en/stable/development/guide.html",
143115
},
144116
{
145-
"name": "Compilation",
146-
"href": "https://pennylane.ai/compilation",
147-
},
148-
{
149-
"name": "Performance",
150-
"href": "https://pennylane.ai/performance",
151-
},
152-
{
153-
"name": "Devices",
154-
"href": "https://pennylane.ai/devices",
117+
"name": "API",
118+
"href": "https://docs.pennylane.ai/en/stable/code/qml.html",
155119
},
156120
{
157-
"name": "Catalyst",
158-
"href": "https://docs.pennylane.ai/projects/catalyst/en/latest/",
121+
"name": "GitHub",
122+
"href": "https://github.com/PennyLaneAI/pennylane",
123+
"external": True,
159124
},
160125
],
161126
},
162127
],
163128
"footer_social_icons": [
164129
{
165-
"name": "Twitter",
166-
"icon": "bx bxl-twitter",
167-
"href": "https://twitter.com/PennyLaneAI",
130+
"name": "LinkedIn",
131+
"icon": "bxl bx-linkedin",
132+
"href": "https://linkedin.com/company/xanaduai/",
168133
},
169134
{
170135
"name": "GitHub",
171-
"icon": "bx bxl-github",
136+
"icon": "bxl bx-github",
172137
"href": "https://github.com/PennyLaneAI/pennylane",
173138
},
174139
{
175-
"name": "Discord",
176-
"icon": "bx bxl-discord",
177-
"href": "https://discord.com/invite/gnySM3nrN3",
140+
"name": "YouTube",
141+
"icon": "bxl bx-youtube",
142+
"href": "https://www.youtube.com/@pennylaneai/",
178143
},
179144
{
180-
"name": "LinkedIn",
181-
"icon": "bx bxl-linkedin",
182-
"href": "https://linkedin.com/company/xanaduai/",
145+
"name": "Twitter",
146+
"icon": "bxl bx-twitter-x",
147+
"href": "https://twitter.com/PennyLaneAI",
183148
},
184149
{
185-
"name": "Discourse",
186-
"icon": "bx bxl-discourse",
187-
"href": "https://discuss.pennylane.ai",
150+
"name": "Discord",
151+
"icon": "bxl bx-discord",
152+
"href": "https://discord.com/invite/gnySM3nrN3",
188153
},
189154
{
190-
"name": "YouTube",
191-
"icon": "bx bxl-youtube",
192-
"href": "https://www.youtube.com/@pennylaneai/",
155+
"name": "Slack",
156+
"icon": "bxl bx-slack",
157+
"href": "https://join.slack.com/t/xanadu-quantum/shared_invite/zt-1i8v8v49d-S76QxXm3OKCm9g0bvWvDpg",
193158
},
194159
{
195-
"name": "Slack",
196-
"icon": "bx bxl-slack",
197-
"href": "https://xanadu-quantum.slack.com/join/shared_invite/zt-nkwn25v9-H4hituCb_PUj4idG0MhSug#/shared-invite/email",
160+
"name": "Discourse",
161+
"icon": "bxl bx-discourse",
162+
"href": "https://discuss.pennylane.ai",
198163
},
199164
],
200165
"footer_taglines": [

0 commit comments

Comments
 (0)