kopia lustrzana https://github.com/jupyterhub/repo2docker
docs: add copybutton, opengraph, rediraffe
rodzic
7ea7454049
commit
7ffeae734a
|
@ -1,4 +1,7 @@
|
||||||
myst-parser>=0.18
|
myst-parser>=0.18
|
||||||
pydata-sphinx-theme>=0.11
|
pydata-sphinx-theme>=0.11
|
||||||
sphinx-autobuild
|
sphinx-autobuild
|
||||||
|
sphinx-copybutton
|
||||||
sphinxcontrib-autoprogram>=0.1.7
|
sphinxcontrib-autoprogram>=0.1.7
|
||||||
|
sphinxext-opengraph
|
||||||
|
sphinxext-rediraffe
|
||||||
|
|
|
@ -18,8 +18,11 @@ author = "Project Jupyter Contributors"
|
||||||
#
|
#
|
||||||
extensions = [
|
extensions = [
|
||||||
"myst_parser",
|
"myst_parser",
|
||||||
|
"sphinx_copybutton",
|
||||||
"sphinx.ext.extlinks",
|
"sphinx.ext.extlinks",
|
||||||
"sphinxcontrib.autoprogram",
|
"sphinxcontrib.autoprogram",
|
||||||
|
"sphinxext.opengraph",
|
||||||
|
"sphinxext.rediraffe",
|
||||||
]
|
]
|
||||||
root_doc = "index"
|
root_doc = "index"
|
||||||
source_suffix = [".md", ".rst"]
|
source_suffix = [".md", ".rst"]
|
||||||
|
@ -87,3 +90,43 @@ html_context = {
|
||||||
"github_version": "main",
|
"github_version": "main",
|
||||||
"doc_path": "docs/source",
|
"doc_path": "docs/source",
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for linkcheck builder -------------------------------------------
|
||||||
|
# ref: https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder
|
||||||
|
#
|
||||||
|
linkcheck_ignore = [
|
||||||
|
r"(.*)github\.com(.*)#", # javascript based anchors
|
||||||
|
r"(.*)/#%21(.*)/(.*)", # /#!forum/jupyter - encoded anchor edge case
|
||||||
|
r"https://github.com/[^/]*$", # too many github usernames / searches in changelog
|
||||||
|
"https://github.com/jupyterhub/repo2docker/pull/", # too many PRs in changelog
|
||||||
|
"https://github.com/jupyterhub/repo2docker/compare/", # too many comparisons in changelog
|
||||||
|
]
|
||||||
|
linkcheck_anchors_ignore = [
|
||||||
|
"/#!",
|
||||||
|
"/#%21",
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for the opengraph extension -------------------------------------
|
||||||
|
# ref: https://github.com/wpilibsuite/sphinxext-opengraph#options
|
||||||
|
#
|
||||||
|
# This extension help others provide better thumbnails and link descriptions
|
||||||
|
# when they link to this documentation from other websites, such as
|
||||||
|
# https://discourse.jupyter.org.
|
||||||
|
#
|
||||||
|
# ogp_site_url is set automatically by RTD
|
||||||
|
ogp_image = "_static/images/logo.png"
|
||||||
|
ogp_use_first_image = True
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for the rediraffe extension -------------------------------------
|
||||||
|
# ref: https://github.com/wpilibsuite/sphinxext-rediraffe#readme
|
||||||
|
#
|
||||||
|
# This extensions help us relocated content without breaking links. If a
|
||||||
|
# document is moved internally, we should configure a redirect like below.
|
||||||
|
#
|
||||||
|
rediraffe_branch = "main"
|
||||||
|
rediraffe_redirects = {
|
||||||
|
# "old-file": "new-folder/new-file-name",
|
||||||
|
}
|
||||||
|
|
Ładowanie…
Reference in New Issue