Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add opengraph plugin #439

Merged
merged 1 commit into from
Jan 16, 2024
Merged

Add opengraph plugin #439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
5 changes: 5 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinxext.opengraph',
'sphinx_copybutton',
]

Expand Down Expand Up @@ -169,3 +170,7 @@
author, 'Flatpak', 'One line description of project.',
'Miscellaneous'),
]

# -- Options for OpenGraph ---------------------------------------------------

ogp_site_url = 'https://docs.flatpak.org/'
1 change: 1 addition & 0 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Sphinx
furo
sphinxext-opengraph
sphinx-copybutton
Loading