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.

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 support for sphinxcontrib-youtube #41

Merged
merged 4 commits into from
Nov 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@
"sphinxcontrib.httpexample", # plone.restapi
"sphinxcontrib.mermaid",
"sphinxcontrib.video",
"sphinxcontrib.youtube",
"sphinxext.opengraph",
]

Expand Down
1 change: 1 addition & 0 deletions docs/reference/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,5 @@ These extensions are built in and can be activated by respective entries in the
It's used by Plone's {doc}`plone:plone.restapi/docs/source/index`.
- [`sphinxcontrib.mermaid`](https://pypi.org/project/sphinxcontrib-mermaid/) allows you to embed [Mermaid](https://mermaid.js.org/) graphs in your documents, including general flowcharts, sequence diagrams, and Gantt charts.
- [`sphinxcontrib.video`](https://pypi.org/project/sphinxcontrib-video/) allows you to embed local videos as defined by the HTML5 standard.
- [`sphinxcontrib.youtube`](https://pypi.org/project/sphinxcontrib-video/) allows you to embed remotely hosted videos from [YouTube](https://www.youtube.com/), [Vimeo](https://vimeo.com/), or [PeerTube](https://joinpeertube.org/).
- [`sphinxext.opengraph`](https://pypi.org/project/sphinxext-opengraph/) generates [OpenGraph metadata](https://ogp.me/).
1 change: 1 addition & 0 deletions news/41.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add support for sphinxcontrib-youtube. @stevepiercy
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ docs = [
"sphinxcontrib.httpdomain",
"sphinxcontrib.httpexample",
"sphinxcontrib-video",
"sphinxcontrib-youtube",
"sphinxext-opengraph",

# Commented from Sphinx Book Theme.
Expand Down
4 changes: 4 additions & 0 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ requests==2.32.3
# pyroma
# requests-toolbelt
# sphinx
# sphinxcontrib-youtube
# twine
# zest-releaser
requests-toolbelt==1.0.0
Expand Down Expand Up @@ -183,6 +184,7 @@ sphinx==7.4.7
# sphinxcontrib-httpexample
# sphinxcontrib-mermaid
# sphinxcontrib-video
# sphinxcontrib-youtube
# sphinxext-opengraph
sphinx-autobuild==2024.10.3
# via
Expand Down Expand Up @@ -228,6 +230,8 @@ sphinxcontrib-serializinghtml==2.0.0
# via sphinx
sphinxcontrib-video==0.3.1
# via plone-sphinx-theme (pyproject.toml)
sphinxcontrib-youtube==1.4.1
# via plone-sphinx-theme (pyproject.toml)
sphinxext-opengraph==0.9.1
# via plone-sphinx-theme (pyproject.toml)
starlette==0.41.2
Expand Down
7 changes: 6 additions & 1 deletion requirements-docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,9 @@ pyyaml==6.0.2
# myst-parser
# sphinxcontrib-mermaid
requests==2.32.3
# via sphinx
# via
# sphinx
# sphinxcontrib-youtube
six==1.16.0
# via
# astunparse
Expand Down Expand Up @@ -100,6 +102,7 @@ sphinx==7.4.7
# sphinxcontrib-httpexample
# sphinxcontrib-mermaid
# sphinxcontrib-video
# sphinxcontrib-youtube
# sphinxext-opengraph
sphinx-autobuild==2024.10.3
# via plone-sphinx-theme (pyproject.toml)
Expand Down Expand Up @@ -141,6 +144,8 @@ sphinxcontrib-serializinghtml==2.0.0
# via sphinx
sphinxcontrib-video==0.3.1
# via plone-sphinx-theme (pyproject.toml)
sphinxcontrib-youtube==1.4.1
# via plone-sphinx-theme (pyproject.toml)
sphinxext-opengraph==0.9.1
# via plone-sphinx-theme (pyproject.toml)
starlette==0.41.2
Expand Down