Skip to content

Commit eefe34b

Browse files
committed
Make sphinx-autoapi optional. Add sphinext-opengraph.
1 parent 53cd180 commit eefe34b

File tree

3 files changed

+51
-33
lines changed

3 files changed

+51
-33
lines changed

docs/source/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
"sphinx.ext.autosectionlabel",
4141
"rst2pdf.pdfbuilder",
4242
"autoapi.extension",
43+
"sphinxext.opengraph",
4344
]
4445

4546
intersphinx_mapping = {
@@ -107,3 +108,6 @@ def skip_member(app, what, name, obj, skip, options): # noqa: ARG001
107108

108109
def setup(sphinx):
109110
sphinx.connect("autoapi-skip-member", skip_member)
111+
112+
113+
ogp_site_url = "https://www.django-unicorn.com/"

poetry.lock

Lines changed: 44 additions & 30 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ furo = { version = "^2023", optional = true }
3131
sphinx-copybutton = { version = "^0", optional = true }
3232
sphinx-autobuild = { version = ">=2021.3.14", optional = true }
3333
rst2pdf = { version = "^0", optional = true }
34-
six = {version = "^1", python = "3.8.*"}
35-
sphinx-autoapi = "^3.0.0"
34+
sphinx-autoapi = { version = "^3.0.0", optional = true }
35+
sphinxext-opengraph = { version = "^0", optional = true }
3636

3737
[tool.poetry.extras]
3838
minify = ["htmlmin"]
39-
docs = ["Sphinx", "linkify-it-py", "myst-parser", "furo", "sphinx-copybutton", "sphinx-autobuild", "rst2pdf"]
39+
docs = ["Sphinx", "linkify-it-py", "myst-parser", "furo", "sphinx-copybutton", "sphinx-autobuild", "rst2pdf", "sphinx-autoapi", "sphinxext-opengraph"]
4040

4141
[tool.poetry.group.dev.dependencies]
4242
certifi = "^2023.7.22" # needed for GitHub Actions

0 commit comments

Comments
 (0)