diff options
| author | Julian Berman <Julian@GrayVines.com> | 2022-08-31 13:12:09 +0300 |
|---|---|---|
| committer | Julian Berman <Julian@GrayVines.com> | 2022-08-31 13:12:09 +0300 |
| commit | 575e786be8bad3f7bc628e2abe09defc3d7fb0bd (patch) | |
| tree | a34e9b333646c849afc9c3e3627b154157a8da5d /docs | |
| parent | 420fc6bd9a3ecc4cd637ece97cb4b482b4d0d37e (diff) | |
| download | jsonschema-575e786be8bad3f7bc628e2abe09defc3d7fb0bd.tar.gz | |
Enable OpenGraph and copy buttons for the docs.
Improves UX a bit and should provide prettier previews
when / if doc links are shared around.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/requirements.in | 2 | ||||
| -rw-r--r-- | docs/requirements.txt | 14 |
3 files changed, 14 insertions, 4 deletions
diff --git a/docs/conf.py b/docs/conf.py index 791111a..f9550c1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -32,8 +32,10 @@ extensions = [ "autoapi.extension", "sphinx_autodoc_typehints", + "sphinx_copybutton", "sphinx_json_schema_spec", "sphinxcontrib.spelling", + "sphinxext.opengraph", ] cache_path = "_cache" diff --git a/docs/requirements.in b/docs/requirements.in index 83e52e5..0a686cf 100644 --- a/docs/requirements.in +++ b/docs/requirements.in @@ -4,5 +4,7 @@ lxml sphinx sphinx-autoapi sphinx-autodoc-typehints +sphinx-copybutton sphinx-json-schema-spec sphinxcontrib-spelling +sphinxext-opengraph diff --git a/docs/requirements.txt b/docs/requirements.txt index 9f2c04f..2b573cc 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -6,7 +6,7 @@ # alabaster==0.7.12 # via sphinx -astroid==2.12.2 +astroid==2.12.5 # via sphinx-autoapi attrs==22.1.0 # via jsonschema @@ -16,7 +16,7 @@ beautifulsoup4==4.11.1 # via furo certifi==2022.6.15 # via requests -charset-normalizer==2.1.0 +charset-normalizer==2.1.1 # via requests docutils==0.19 # via sphinx @@ -69,15 +69,19 @@ sphinx==5.1.1 # sphinx-autoapi # sphinx-autodoc-typehints # sphinx-basic-ng + # sphinx-copybutton # sphinx-json-schema-spec # sphinxcontrib-spelling + # sphinxext-opengraph sphinx-autoapi==1.9.0 # via -r docs/requirements.in sphinx-autodoc-typehints==1.19.2 # via -r docs/requirements.in sphinx-basic-ng==0.0.1a12 # via furo -sphinx-json-schema-spec==2.2.2 +sphinx-copybutton==0.5.0 + # via -r docs/requirements.in +sphinx-json-schema-spec==2.2.3 # via -r docs/requirements.in sphinxcontrib-applehelp==1.0.2 # via sphinx @@ -93,9 +97,11 @@ sphinxcontrib-serializinghtml==1.1.5 # via sphinx sphinxcontrib-spelling==7.6.0 # via -r docs/requirements.in +sphinxext-opengraph==0.6.3 + # via -r docs/requirements.in unidecode==1.3.4 # via sphinx-autoapi -urllib3==1.26.11 +urllib3==1.26.12 # via requests wrapt==1.14.1 # via astroid |