opengraph card 2

ameli · Aug 11, 2023 · 4775937 · 4775937
1 parent 7570aa6
commit 4775937
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 4 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -11,6 +11,7 @@ sphinx-multitoc-numbering
 sphinx-prompt
 sphinx-copybutton
 sphinx-gallery
+sphinxext-opengraph
 jinja2==3.1.2
 sphinx-argparse
 scipy
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -142,6 +142,7 @@
     'nbsphinx',
     'sphinx_gallery.load_style',
     'sphinxarg.ext',
+    "sphinxext.opengraph",
 ]
 
 # Inner-sphinx to cross-reference other packages
@@ -264,7 +265,6 @@
 #     "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"
 # ]
 
-
 html_title = f"{project} Manual"
 html_last_updated_fmt = '%b %d, %Y'
 # html_show_sourcelink = False
@@ -290,7 +290,6 @@
 # extensions.append('sphinxjp.themes.basicstrap')
 # html_theme = 'basicstrap'
 
-
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
@@ -304,6 +303,13 @@
 # html_logo = '_static/images/icons/logo-restoreio-light.png'
 html_favicon = '_static/images/icons/favicon.ico'
 
+# Open Graph cards for sharing the documentation on social media
+ogp_site_url = 'https://ameli.github.io/restoreio'
+ogp_image = 'https://restoreio.org/public/images/card.png'
+ogp_site_name = 'RestoreIO'
+ogp_description_length = 300
+ogp_type = "website"
+
 # =====
 # setup
 # =====

diff --git a/docs/source/contents.rst b/docs/source/contents.rst
@@ -2,7 +2,7 @@
 .. toctree::
     :maxdepth: 2
 
-    Install <install>
+    Install <install/install>
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -112,7 +112,7 @@ For complete installation guide, see:
 .. toctree::
     :maxdepth: 2
 
-    Install <install>
+    Install <install/install>
 
 User Guide
 ==========