diff --git a/README.rst b/README.rst index 8f9dfc86..04aa23b0 100644 --- a/README.rst +++ b/README.rst @@ -17,11 +17,11 @@ To build the docs locally, first install ``sphinx``, ``furo`` and ``sphinx-copybutton``. On Fedora this can be with:: - sudo dnf install python3-sphinx python3-furo python-sphinx-copybutton + sudo dnf install python3-sphinx python3-furo python-sphinx-copybutton python-sphinxext-opengraph On Debian this can be with:: - sudo apt install python3-sphinx python3-furo python-sphinx-copybutton + sudo apt install python3-sphinx python3-furo python-sphinx-copybutton python-sphinxext-opengraph Then run ``make html`` in the ``docs`` directory. diff --git a/docs/conf.py b/docs/conf.py index ae8ecc1d..cad2856a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -32,6 +32,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'sphinxext.opengraph', 'sphinx_copybutton', ] @@ -169,3 +170,7 @@ author, 'Flatpak', 'One line description of project.', 'Miscellaneous'), ] + +# -- Options for OpenGraph --------------------------------------------------- + +ogp_site_url = 'https://docs.flatpak.org/' diff --git a/requirements.txt b/requirements.txt index 2f73c474..fd9eefa8 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,4 @@ Sphinx furo +sphinxext-opengraph sphinx-copybutton