Skip to content

Commit cf31ba1

Browse files
committed
Merge: resolve conflicts and ensure ogp_site_url set to live docs; keep sphinxext-opengraph in requirements
2 parents 6357e3f + ee55ce9 commit cf31ba1

File tree

2 files changed

+18
-3
lines changed

2 files changed

+18
-3
lines changed

doc/requirements-docs.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ sphinx-markdown-tables
77
sphinx-notfound-page
88
sphinx_rtd_theme
99
sphinxext-opengraph
10-
matplotlib
10+
matplotlib

doc/source/conf.py

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,15 @@
33
# For the full list of built-in configuration values, see the documentation:
44
# https://www.sphinx-doc.org/en/master/usage/configuration.html
55

6+
67
# -- Project information -----------------------------------------------------
78
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
89

910
project = "64 Shades"
1011
copyright = "2025, 64 Shades"
1112
author = "64 Shades"
1213

14+
1315
# -- General configuration ---------------------------------------------------
1416
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
1517

@@ -19,15 +21,16 @@
1921
] # type: ignore
2022

2123
# Open Graph extension configuration
22-
ogp_site_url = "https://Subham-KRLX.github.io/" # Replace with your actual docs URL
23-
24+
# Point to the live documentation site so previews link to the published pages.
25+
ogp_site_url = "https://64-shades.github.io/"
2426
ogp_description_length = 200 # Optional, number of characters to use for descriptions
2527
ogp_type = "website" # Optional, type of page (usually 'website' for docs)
2628

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

33+
3134
# -- Options for HTML output -------------------------------------------------
3235
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
3336

@@ -36,6 +39,9 @@
3639

3740
html_logo = "_static/images/logo.jpeg"
3841

42+
# Favicon for the documentation site
43+
html_favicon = "_static/images/favicon.ico"
44+
3945
# Add your custom CSS file (updated to use the new CSS variables)
4046
html_css_files = ["css/custom.css"]
4147

@@ -62,3 +68,12 @@
6268
"github_type": "fork", # Use 'watch' for the Star button
6369
# REMOVED: The extra_nav_links are now placed directly via the template file
6470
}
71+
72+
# -- Open Graph / social metadata -----------------------------------------
73+
# Point to the live documentation site so previews link to the published pages.
74+
# Use the GitHub Pages URL for this repository's docs site.
75+
ogp_site_url = "https://64-shades.github.io/"
76+
# How many characters of the page body to use as the og:description (optional)
77+
ogp_description_length = 200
78+
# Default Open Graph object type
79+
ogp_type = "website"

0 commit comments

Comments
 (0)