update example docs configuration to support source links (#610)

This makes the pencil icon visible
Qiskit · Jun 18, 2024 · e8ca8e5 · e8ca8e5
1 parent 99be077
commit e8ca8e5
Show file tree

Hide file tree

Showing 9 changed files with 5 additions and 0 deletions.
diff --git a/example_docs/docs/conf.py b/example_docs/docs/conf.py
@@ -23,6 +23,11 @@
 release = "9.99"
 
 html_theme = "qiskit-ecosystem"
+html_theme_options = {
+    "source_repository": "https://github.com/Qiskit/qiskit_sphinx_theme/",
+    "source_branch": "main",
+    "source_directory": "example_docs/docs/",
+}
 
 # This allows including custom CSS and HTML templates.
 html_static_path = ["_static"]

diff --git a/tests/js/tests.js-snapshots/Jupyter-works-with-copybutton-1-linux.png b/tests/js/tests.js-snapshots/Jupyter-works-with-copybutton-1-linux.png
diff --git a/tests/js/tests.js-snapshots/Sphinx-Design-elements-have-no-shadows-1-linux.png b/tests/js/tests.js-snapshots/Sphinx-Design-elements-have-no-shadows-1-linux.png
diff --git a/tests/js/tests.js-snapshots/api-docs-class-page-1-linux.png b/tests/js/tests.js-snapshots/api-docs-class-page-1-linux.png
diff --git a/tests/js/tests.js-snapshots/api-docs-function-page-1-linux.png b/tests/js/tests.js-snapshots/api-docs-function-page-1-linux.png
diff --git a/tests/js/tests.js-snapshots/api-docs-inline-classes-1-linux.png b/tests/js/tests.js-snapshots/api-docs-inline-classes-1-linux.png
diff --git a/tests/js/tests.js-snapshots/api-docs-module-page-1-linux.png b/tests/js/tests.js-snapshots/api-docs-module-page-1-linux.png
diff --git a/...s/js/tests.js-snapshots/inline-table-of-contents-have-correct-fonts-1-linux.png b/...s/js/tests.js-snapshots/inline-table-of-contents-have-correct-fonts-1-linux.png
diff --git a/.../tests.js-snapshots/top-nav-bar-uses-custom-page-ToC-icon-on-tablet-1-linux.png b/.../tests.js-snapshots/top-nav-bar-uses-custom-page-ToC-icon-on-tablet-1-linux.png