hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-13 13:03:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add opengraph sphinx extension

Browse Source 
This extension helps add metadata etc to the rendered HTML documentation
to help for example links on discourse.jupyter.org look good.
This commit is contained in:
Erik Sundell
2022-11-22 17:16:08 +01:00
parent 96d4486ae5
commit d23e095106
2 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/requirements.txt
View File

@@ -17,3 +17,4 @@ ruamel.yaml
sphinx>=4 sphinx>=4
sphinx-copybutton sphinx-copybutton
sphinx-jsonschema sphinx-jsonschema
sphinxext-opengraph

7
docs/source/conf.py
View File

@@ -34,6 +34,7 @@ extensions = [
"autodoc_traits", "autodoc_traits",
"sphinx_copybutton", "sphinx_copybutton",
"sphinx-jsonschema", "sphinx-jsonschema",
"sphinxext.opengraph",
"myst_parser", "myst_parser",
] ]
root_doc = "index" root_doc = "index"
@@ -192,3 +193,9 @@ intersphinx_mapping = {
"python": ("https://docs.python.org/3/", None), "python": ("https://docs.python.org/3/", None),
"tornado": ("https://www.tornadoweb.org/en/stable/", None), "tornado": ("https://www.tornadoweb.org/en/stable/", None),
} }
# -- Options for the opengraph extension -------------------------------------
# ref: https://github.com/wpilibsuite/sphinxext-opengraph#options
#
# ogp_site_url is set automatically by RTD
ogp_image = "_static/logo.png"
ogp_use_first_image = True