Skip to content

Enable sphinxext-opengraph for Open Graph metadata #214

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

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

Enable sphinxext-opengraph for Open Graph metadata #214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
397d4c1
Enable sphinxext-opengraph for Open Graph metadata
Subham-KRLX Oct 20, 2025
e98c447
Merge branch 'main' into add-sphinx-opengraph
Subham-KRLX Oct 20, 2025
6357e3f
Add sphinxext-opengraph and matplotlib to documentation requirements
Subham-KRLX Oct 20, 2025
b707685
Set up html_favicon for custom favicon image in Sphinx docs
Subham-KRLX Oct 22, 2025
ee55ce9
docs: enable sphinxext-opengraph and point ogp_site_url to live docs;…
Subham-KRLX Oct 22, 2025
cf31ba1
Merge: resolve conflicts and ensure ogp_site_url set to live docs; ke…
Subham-KRLX Nov 4, 2025
10b16c1
Merge branch 'main' into add-sphinx-opengraph
Subham-KRLX Nov 4, 2025
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
2 changes: 2 additions & 0 deletions doc/requirements-docs.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@ sphinx-intl
sphinx-markdown-tables
sphinx-notfound-page
sphinx_rtd_theme
sphinxext-opengraph
matplotlib
22 changes: 22 additions & 0 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,34 @@
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html


# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = "64 Shades"
copyright = "2025, 64 Shades"
author = "64 Shades"


# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = [
"notfound.extension",
"sphinxext.opengraph",
] # type: ignore

# Open Graph extension configuration
# Point to the live documentation site so previews link to the published pages.
ogp_site_url = "https://64-shades.github.io/"
ogp_description_length = 200 # Optional, number of characters to use for descriptions
ogp_type = "website" # Optional, type of page (usually 'website' for docs)

# NOTE: We keep templates_path to ensure our new template is found
templates_path = ["_templates"]
exclude_patterns = [] # type: ignore


nitpicky = True

# -- Options for HTML output -------------------------------------------------
Expand All @@ -31,6 +41,9 @@

html_logo = "_static/images/logo.jpeg"

# Favicon for the documentation site
html_favicon = "_static/images/favicon.ico"

# Add your custom CSS file (updated to use the new CSS variables)
html_css_files = ["css/custom.css"]

Expand Down Expand Up @@ -60,3 +73,12 @@
"show_relbar_top": False,
"show_relbar_bottom": True,
}

# -- Open Graph / social metadata -----------------------------------------
# Point to the live documentation site so previews link to the published pages.
# Use the GitHub Pages URL for this repository's docs site.
ogp_site_url = "https://64-shades.github.io/"
# How many characters of the page body to use as the og:description (optional)
ogp_description_length = 200
# Default Open Graph object type
ogp_type = "website"
Loading