Merge pull request #1227 from ejoerns/topic/opengraph

add opengraph sphinx extension for social media preview
rauc · Aug 17, 2023 · d61a99d · d61a99d
2 parents aee0bfd + 6d8cb23
commit d61a99d
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 0 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -7,3 +7,7 @@ build:
 
 sphinx:
   configuration: docs/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt
diff --git a/docs/conf.py b/docs/conf.py
@@ -25,8 +25,12 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.coverage',
     'sphinx.ext.ifconfig',
+    'sphinxext.opengraph',
 ]
 
+ogp_site_url = 'https://rauc.readthedocs.io/en/latest/'
+ogp_image = 'https://rauc.readthedocs.io/en/latest/_static/RAUC_Logo_outline.svg'
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1 @@
+sphinxext-opengraph
diff --git a/test/Dockerfile b/test/Dockerfile
@@ -20,6 +20,8 @@ RUN apt-get update && apt-get install -y \
   lcov \
   slirp \
   python3-sphinx \
+  python3-sphinx-rtd-theme \
+  python3-sphinxext-opengraph \
   dbus-x11 \
   user-mode-linux \
   grub-common \