Skip to content
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

Upload and update global opengraph image, and create a opengraph description override for homepage #6696

Merged
merged 17 commits into from
Dec 13, 2024
Merged

Upload and update global opengraph image, and create a opengraph description override for homepage #6696

Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
db87cab
add: opengraph.png to doc/__static, update: ogp_image in doc/conf.py
Alan-eMartin Dec 10, 2024
6afe399
add: override to og-desc on doc homepage
Alan-eMartin Dec 10, 2024
3c6cbea
update metafield directly on page, update changelog-dev
Alan-eMartin Dec 10, 2024
d67fff4
update meta-key naming
Alan-eMartin Dec 10, 2024
157e6b0
try sphinxtext-opengraph approach
Alan-eMartin Dec 10, 2024
41ef4af
Merge branch 'master' into update-og-image-and-desc
Alan-eMartin Dec 10, 2024
8f0009b
Merge branch 'master' into update-og-image-and-desc
Alan-eMartin Dec 11, 2024
e501119
requirement added: update og title
Alan-eMartin Dec 11, 2024
034e6a4
update changelog to reflect new changes
Alan-eMartin Dec 11, 2024
d5e494d
fix spacing
Alan-eMartin Dec 11, 2024
ac0a794
rm: title change
Alan-eMartin Dec 13, 2024
45e5008
remove title form change log
Alan-eMartin Dec 13, 2024
e9a9f33
Merge branch 'master' into update-og-image-and-desc
Alan-eMartin Dec 13, 2024
410b85b
Merge branch 'master' into update-og-image-and-desc
Alan-eMartin Dec 13, 2024
1092591
Merge branch 'master' into update-og-image-and-desc
Alan-eMartin Dec 13, 2024
5d35403
Merge branch 'master' into update-og-image-and-desc
Alan-eMartin Dec 13, 2024
a004afe
Merge branch 'master' into update-og-image-and-desc
Alan-eMartin Dec 13, 2024
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
Binary file added doc/_static/opengraph.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"site_url": "https://docs.pennylane.ai/",
"line_color": "#03b2ff",
}
ogp_image = "_static/header-tall.png"
ogp_image = "_static/opengraph.png"


# The base URL with a proper language and version.
Expand Down
2 changes: 2 additions & 0 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:og:description: Accelerate your adoption of PennyLane! Find clear, concise, accessible, and current information that will help you understand, use, and troubleshoot issues.

PennyLane Documentation
=======================

Expand Down
4 changes: 4 additions & 0 deletions doc/releases/changelog-dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -464,6 +464,9 @@ same information.
* Add a warning message to Gradients and training documentation about ComplexWarnings.
[(#6543)](https://github.com/PennyLaneAI/pennylane/pull/6543)

* Added `opengraph.png` asset and configured `opengraph` metadata image. Overrode the documentation landing page `meta-description`.
[(#6696)](https://github.com/PennyLaneAI/pennylane/pull/6696)

<h3>Bug fixes 🐛</h3>

* The `Wires` object throws a `TypeError` if `wires=None`.
Expand Down Expand Up @@ -510,6 +513,7 @@ Pietropaolo Frisoni,
Austin Huang,
Korbinian Kottmann,
Christina Lee,
Alan Martin,
William Maxwell,
Andrija Paurevic,
Justin Pickering,
Expand Down
Loading