mirror of
https://github.com/ManimCommunity/manim.git
synced 2026-06-22 10:01:47 +00:00
docs: enable social cards (#3219)
This is new feature of `sphinxext-opengraph` which will automatically generate social cards for the documentation. This is a new feature and it is not enabled is there is a custom `ogp_image` defined, which we do. Remove it and also make sure it adds our logo to the social cards.
This commit is contained in:
Naveen M K
GitHub
parent
06f60f6021
commit
a7a972bf66
4 changed files with 29 additions and 25 deletions
BIN
docs/source/_static/logo.png
Normal file
BIN
docs/source/_static/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
|
|
@ -143,9 +143,11 @@ extlinks = {
|
|||
}
|
||||
|
||||
# opengraph settings
|
||||
ogp_image = "https://www.manim.community/logo.png"
|
||||
ogp_site_name = "Manim Community | Documentation"
|
||||
ogp_site_url = "https://docs.manim.community/"
|
||||
ogp_social_cards = {
|
||||
"image": "_static/logo.png",
|
||||
}
|
||||
|
||||
|
||||
# inheritance_graph settings
|
||||
|
|
|
|||
48
poetry.lock
generated
48
poetry.lock
generated
|
|
@ -1,4 +1,4 @@
|
|||
# This file is automatically @generated by Poetry and should not be changed by hand.
|
||||
# This file is automatically @generated by Poetry 1.4.2 and should not be changed by hand.
|
||||
|
||||
[[package]]
|
||||
name = "alabaster"
|
||||
|
|
@ -38,7 +38,7 @@ name = "appnope"
|
|||
version = "0.1.3"
|
||||
description = "Disable App Nap on macOS >= 10.9"
|
||||
category = "main"
|
||||
optional = false
|
||||
optional = true
|
||||
python-versions = "*"
|
||||
files = [
|
||||
{file = "appnope-0.1.3-py2.py3-none-any.whl", hash = "sha256:265a455292d0bd8a72453494fa24df5a11eb18373a60c7c0430889f22548605e"},
|
||||
|
|
@ -155,7 +155,7 @@ name = "asttokens"
|
|||
version = "2.2.1"
|
||||
description = "Annotate AST trees with source code positions"
|
||||
category = "main"
|
||||
optional = false
|
||||
optional = true
|
||||
python-versions = "*"
|
||||
files = [
|
||||
{file = "asttokens-2.2.1-py2.py3-none-any.whl", hash = "sha256:6b0ac9e93fb0335014d382b8fa9b3afa7df546984258005da0b9e7095b3deb1c"},
|
||||
|
|
@ -206,7 +206,7 @@ name = "backcall"
|
|||
version = "0.2.0"
|
||||
description = "Specifications for callback functions passed in to an API"
|
||||
category = "main"
|
||||
optional = false
|
||||
optional = true
|
||||
python-versions = "*"
|
||||
files = [
|
||||
{file = "backcall-0.2.0-py2.py3-none-any.whl", hash = "sha256:fbbce6a29f263178a1f7915c1940bde0ec2b2a967566fe1c65c1dfb7422bd255"},
|
||||
|
|
@ -934,7 +934,7 @@ name = "executing"
|
|||
version = "1.2.0"
|
||||
description = "Get the currently executing AST node of a frame, and other information"
|
||||
category = "main"
|
||||
optional = false
|
||||
optional = true
|
||||
python-versions = "*"
|
||||
files = [
|
||||
{file = "executing-1.2.0-py2.py3-none-any.whl", hash = "sha256:0314a69e37426e3608aada02473b4161d4caf5a4b244d1d0c48072b8fee7bacc"},
|
||||
|
|
@ -1394,7 +1394,7 @@ name = "ipython"
|
|||
version = "8.10.0"
|
||||
description = "IPython: Productive Interactive Computing"
|
||||
category = "main"
|
||||
optional = false
|
||||
optional = true
|
||||
python-versions = ">=3.8"
|
||||
files = [
|
||||
{file = "ipython-8.10.0-py3-none-any.whl", hash = "sha256:b38c31e8fc7eff642fc7c597061fff462537cf2314e3225a19c906b7b0d8a345"},
|
||||
|
|
@ -1493,7 +1493,7 @@ name = "jedi"
|
|||
version = "0.18.2"
|
||||
description = "An autocompletion tool for Python that can be used for text editors."
|
||||
category = "main"
|
||||
optional = false
|
||||
optional = true
|
||||
python-versions = ">=3.6"
|
||||
files = [
|
||||
{file = "jedi-0.18.2-py2.py3-none-any.whl", hash = "sha256:203c1fd9d969ab8f2119ec0a3342e0b49910045abe6af0a3ae83a5764d54639e"},
|
||||
|
|
@ -2126,7 +2126,7 @@ name = "matplotlib-inline"
|
|||
version = "0.1.6"
|
||||
description = "Inline Matplotlib backend for Jupyter"
|
||||
category = "main"
|
||||
optional = false
|
||||
optional = true
|
||||
python-versions = ">=3.5"
|
||||
files = [
|
||||
{file = "matplotlib-inline-0.1.6.tar.gz", hash = "sha256:f887e5f10ba98e8d2b150ddcf4702c1e5f8b3a20005eb0f74bfdbd360ee6f304"},
|
||||
|
|
@ -2263,6 +2263,7 @@ category = "main"
|
|||
optional = false
|
||||
python-versions = ">=3.6"
|
||||
files = [
|
||||
{file = "moderngl-window-2.4.2.tar.gz", hash = "sha256:5a31d790beed76964b4d4037c9d93302ff403bb813e7ba506c834895dfc59bb4"},
|
||||
{file = "moderngl_window-2.4.2-py3-none-any.whl", hash = "sha256:19aca4048ca037bd9f2ca8b154ac15d07e90a05ad2d5fce32d746be8ffcc319d"},
|
||||
]
|
||||
|
||||
|
|
@ -2662,7 +2663,7 @@ name = "parso"
|
|||
version = "0.8.3"
|
||||
description = "A Python Parser"
|
||||
category = "main"
|
||||
optional = false
|
||||
optional = true
|
||||
python-versions = ">=3.6"
|
||||
files = [
|
||||
{file = "parso-0.8.3-py2.py3-none-any.whl", hash = "sha256:c001d4636cd3aecdaf33cbb40aebb59b094be2a74c556778ef5576c175e19e75"},
|
||||
|
|
@ -2690,7 +2691,7 @@ name = "pexpect"
|
|||
version = "4.8.0"
|
||||
description = "Pexpect allows easy control of interactive console applications."
|
||||
category = "main"
|
||||
optional = false
|
||||
optional = true
|
||||
python-versions = "*"
|
||||
files = [
|
||||
{file = "pexpect-4.8.0-py2.py3-none-any.whl", hash = "sha256:0b48a55dcb3c05f3329815901ea4fc1537514d6ba867a152b581d69ae3710937"},
|
||||
|
|
@ -2705,7 +2706,7 @@ name = "pickleshare"
|
|||
version = "0.7.5"
|
||||
description = "Tiny 'shelve'-like database with concurrency support"
|
||||
category = "main"
|
||||
optional = false
|
||||
optional = true
|
||||
python-versions = "*"
|
||||
files = [
|
||||
{file = "pickleshare-0.7.5-py2.py3-none-any.whl", hash = "sha256:9649af414d74d4df115d5d718f82acb59c9d418196b7b4290ed47a12ce62df56"},
|
||||
|
|
@ -2871,7 +2872,7 @@ name = "prompt-toolkit"
|
|||
version = "3.0.36"
|
||||
description = "Library for building powerful interactive command lines in Python"
|
||||
category = "main"
|
||||
optional = false
|
||||
optional = true
|
||||
python-versions = ">=3.6.2"
|
||||
files = [
|
||||
{file = "prompt_toolkit-3.0.36-py3-none-any.whl", hash = "sha256:aa64ad242a462c5ff0363a7b9cfe696c20d55d9fc60c11fd8e632d064804d305"},
|
||||
|
|
@ -2939,7 +2940,7 @@ name = "ptyprocess"
|
|||
version = "0.7.0"
|
||||
description = "Run a subprocess in a pseudo terminal"
|
||||
category = "main"
|
||||
optional = false
|
||||
optional = true
|
||||
python-versions = "*"
|
||||
files = [
|
||||
{file = "ptyprocess-0.7.0-py2.py3-none-any.whl", hash = "sha256:4b41f3967fce3af57cc7e94b888626c18bf37a083e3651ca8feeb66d492fef35"},
|
||||
|
|
@ -2951,7 +2952,7 @@ name = "pure-eval"
|
|||
version = "0.2.2"
|
||||
description = "Safely evaluate AST nodes without side effects"
|
||||
category = "main"
|
||||
optional = false
|
||||
optional = true
|
||||
python-versions = "*"
|
||||
files = [
|
||||
{file = "pure_eval-0.2.2-py3-none-any.whl", hash = "sha256:01eaab343580944bc56080ebe0a674b39ec44a945e6d09ba7db3cb8cec289350"},
|
||||
|
|
@ -4068,18 +4069,19 @@ test = ["pytest"]
|
|||
|
||||
[[package]]
|
||||
name = "sphinxext-opengraph"
|
||||
version = "0.5.1"
|
||||
version = "0.8.2"
|
||||
description = "Sphinx Extension to enable OGP support"
|
||||
category = "dev"
|
||||
optional = false
|
||||
python-versions = ">=3.6"
|
||||
python-versions = ">=3.7"
|
||||
files = [
|
||||
{file = "sphinxext-opengraph-0.5.1.tar.gz", hash = "sha256:78675a8a490c749a881892abc4f28ac3a2e8e65b066fe346fa7da882290906a5"},
|
||||
{file = "sphinxext_opengraph-0.5.1-py3-none-any.whl", hash = "sha256:3fd0df576ae11e55c710653413edd7c05db65a4fbf985d536127c5ac06f5d2cb"},
|
||||
{file = "sphinxext-opengraph-0.8.2.tar.gz", hash = "sha256:45a693b6704052c426576f0a1f630649c55b4188bc49eb63e9587e24a923db39"},
|
||||
{file = "sphinxext_opengraph-0.8.2-py3-none-any.whl", hash = "sha256:6a05bdfe5176d9dd0a1d58a504f17118362ab976631213cd36fb44c4c40544c9"},
|
||||
]
|
||||
|
||||
[package.dependencies]
|
||||
sphinx = ">=2.0"
|
||||
matplotlib = "*"
|
||||
sphinx = ">=4.0"
|
||||
|
||||
[[package]]
|
||||
name = "srt"
|
||||
|
|
@ -4097,7 +4099,7 @@ name = "stack-data"
|
|||
version = "0.6.2"
|
||||
description = "Extract data from python stack frames and tracebacks for informative displays"
|
||||
category = "main"
|
||||
optional = false
|
||||
optional = true
|
||||
python-versions = "*"
|
||||
files = [
|
||||
{file = "stack_data-0.6.2-py3-none-any.whl", hash = "sha256:cbb2a53eb64e5785878201a97ed7c7b94883f48b87bfb0bbe8b623c74679e4a8"},
|
||||
|
|
@ -4247,7 +4249,7 @@ name = "traitlets"
|
|||
version = "5.6.0"
|
||||
description = "Traitlets Python configuration system"
|
||||
category = "main"
|
||||
optional = false
|
||||
optional = true
|
||||
python-versions = ">=3.7"
|
||||
files = [
|
||||
{file = "traitlets-5.6.0-py3-none-any.whl", hash = "sha256:1410755385d778aed847d68deb99b3ba30fbbf489e17a1e8cbb753060d5cce73"},
|
||||
|
|
@ -4472,7 +4474,7 @@ name = "wcwidth"
|
|||
version = "0.2.5"
|
||||
description = "Measures the displayed width of unicode strings in a terminal"
|
||||
category = "main"
|
||||
optional = false
|
||||
optional = true
|
||||
python-versions = "*"
|
||||
files = [
|
||||
{file = "wcwidth-0.2.5-py2.py3-none-any.whl", hash = "sha256:beb4802a9cebb9144e99086eff703a642a13d6a0052920003a230f3294bbe784"},
|
||||
|
|
@ -4617,4 +4619,4 @@ jupyterlab = ["jupyterlab", "notebook"]
|
|||
[metadata]
|
||||
lock-version = "2.0"
|
||||
python-versions = ">=3.8,<3.12"
|
||||
content-hash = "9df7ccd72cfd7f4a98b9a39546c11e4302f0390eecedd60882a8f4cdb7ffb22b"
|
||||
content-hash = "28a396c4e162aaa239599929f59ea1a96a5cee669ce7dbe0c9c23e22a42488f6"
|
||||
|
|
|
|||
|
|
@ -68,7 +68,7 @@ pytest = "^7.2"
|
|||
pylint = "^2.12.2"
|
||||
Sphinx = "^4"
|
||||
sphinx-copybutton = "^0.4.0"
|
||||
sphinxext-opengraph = "^0.5.1"
|
||||
sphinxext-opengraph = "^0.8"
|
||||
furo = "^2022.06.21"
|
||||
recommonmark = "^0.7.1"
|
||||
matplotlib = "^3.3.2"
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue