Inicio Explorar Ayuda
Iniciar sesión
Godot
/
godot-docs
espejo de https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Archivos Incidencias 0 Wiki
Explorar el Código

Add Open Graph tags for better link preview on social media

This is provided by the sphinxext-opengraph extension.

This also adds a theme color property in the HTML layout file.

(cherry picked from commit 9becaa548031266bc670d5fe93e49b8e1eb708d7)
Hugo Locurcio hace 4 años
padre
0175c3e4fe
commit
6c87f04926
Se han modificado 3 ficheros con 8 adiciones y 0 borrados
Unificar vista Mostrar estadísticas de diff
  1. 1 0
      _templates/layout.html
  2. 4 0
      conf.py
  3. 3 0
      requirements.txt

+ 1 - 0
_templates/layout.html
Ver fichero 

@@ -1,5 +1,6 @@
 
 {% extends "!layout.html" -%}
 
 {% extends "!layout.html" -%}
 
 {% block linktags -%}
 
 {% block linktags -%}
 
+  <meta name="theme-color" content="#3d8fcc">
 
   {% if godot_inject_language_links -%}
 
   {% if godot_inject_language_links -%}
 
   {% for alternate_lang in godot_docs_supported_languages -%}
 
   {% for alternate_lang in godot_docs_supported_languages -%}
 
   {# Convert to ISO 639-1 format, e.g. zh_CN -> zh-cn -#}
 
   {# Convert to ISO 639-1 format, e.g. zh_CN -> zh-cn -#}

+ 4 - 0
conf.py
Ver fichero 

@@ -15,6 +15,7 @@ sys.path.append(os.path.abspath("_extensions"))
 
 extensions = [
 
 extensions = [
 
     "sphinx_tabs.tabs",
 
     "sphinx_tabs.tabs",
 
     "notfound.extension",
 
     "notfound.extension",
 
+    "sphinxext.opengraph",
 
 ]
 
 ]
 
 
 
 # Warning when the Sphinx Tabs extension is used with unknown
 
 # Warning when the Sphinx Tabs extension is used with unknown
 
@@ -54,6 +55,9 @@ on_rtd = os.environ.get("READTHEDOCS", None) == "True"
 
 if not on_rtd:
 
 if not on_rtd:
 
     notfound_urls_prefix = ''
 
     notfound_urls_prefix = ''
 
 
 
+# Specify the site name for the Open Graph extension.
 
+ogp_site_name = "Godot Engine documentation"
 
+
 
 if not os.getenv("SPHINX_NO_GDSCRIPT"):
 
 if not os.getenv("SPHINX_NO_GDSCRIPT"):
 
     extensions.append("gdscript")
 
     extensions.append("gdscript")

+ 3 - 0
requirements.txt
Ver fichero 

@@ -12,5 +12,8 @@ sphinx-tabs==1.1.13
 
 # Custom 404 error page (more useful than the default)
 
 # Custom 404 error page (more useful than the default)
 
 sphinx-notfound-page==0.6
 
 sphinx-notfound-page==0.6
 
 
 
+# Adds Open Graph tags in the HTML `<head>` tag
 
+sphinxext-opengraph==0.4.1
 
+
 
 # Full-page search UI for RTD: https://readthedocs-sphinx-search.readthedocs.io
 
 # Full-page search UI for RTD: https://readthedocs-sphinx-search.readthedocs.io
 
 readthedocs-sphinx-search==0.1.0rc3
 
 readthedocs-sphinx-search==0.1.0rc3