Skip to content

Commit 575e786

Browse files
committed
Enable OpenGraph and copy buttons for the docs.
Improves UX a bit and should provide prettier previews when / if doc links are shared around.
1 parent 420fc6b commit 575e786

File tree

3 files changed

+14
-4
lines changed

3 files changed

+14
-4
lines changed

docs/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,10 @@
3232

3333
"autoapi.extension",
3434
"sphinx_autodoc_typehints",
35+
"sphinx_copybutton",
3536
"sphinx_json_schema_spec",
3637
"sphinxcontrib.spelling",
38+
"sphinxext.opengraph",
3739
]
3840

3941
cache_path = "_cache"

docs/requirements.in

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,7 @@ lxml
44
sphinx
55
sphinx-autoapi
66
sphinx-autodoc-typehints
7+
sphinx-copybutton
78
sphinx-json-schema-spec
89
sphinxcontrib-spelling
10+
sphinxext-opengraph

docs/requirements.txt

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
#
77
alabaster==0.7.12
88
# via sphinx
9-
astroid==2.12.2
9+
astroid==2.12.5
1010
# via sphinx-autoapi
1111
attrs==22.1.0
1212
# via jsonschema
@@ -16,7 +16,7 @@ beautifulsoup4==4.11.1
1616
# via furo
1717
certifi==2022.6.15
1818
# via requests
19-
charset-normalizer==2.1.0
19+
charset-normalizer==2.1.1
2020
# via requests
2121
docutils==0.19
2222
# via sphinx
@@ -69,15 +69,19 @@ sphinx==5.1.1
6969
# sphinx-autoapi
7070
# sphinx-autodoc-typehints
7171
# sphinx-basic-ng
72+
# sphinx-copybutton
7273
# sphinx-json-schema-spec
7374
# sphinxcontrib-spelling
75+
# sphinxext-opengraph
7476
sphinx-autoapi==1.9.0
7577
# via -r docs/requirements.in
7678
sphinx-autodoc-typehints==1.19.2
7779
# via -r docs/requirements.in
7880
sphinx-basic-ng==0.0.1a12
7981
# via furo
80-
sphinx-json-schema-spec==2.2.2
82+
sphinx-copybutton==0.5.0
83+
# via -r docs/requirements.in
84+
sphinx-json-schema-spec==2.2.3
8185
# via -r docs/requirements.in
8286
sphinxcontrib-applehelp==1.0.2
8387
# via sphinx
@@ -93,9 +97,11 @@ sphinxcontrib-serializinghtml==1.1.5
9397
# via sphinx
9498
sphinxcontrib-spelling==7.6.0
9599
# via -r docs/requirements.in
100+
sphinxext-opengraph==0.6.3
101+
# via -r docs/requirements.in
96102
unidecode==1.3.4
97103
# via sphinx-autoapi
98-
urllib3==1.26.11
104+
urllib3==1.26.12
99105
# via requests
100106
wrapt==1.14.1
101107
# via astroid

0 commit comments

Comments
 (0)