Removal of 'Edit on Github' link for API pages of KQC documentation - F…

…ixes #92 (#93) * added breadcrumbs.html to manage 'github_url' meta * added github_url meta to relevant files preventing undesired github link rendering
iqm-finland · May 31, 2024 · 08d7d8a · 08d7d8a
1 parent 097fb6f
commit 08d7d8a
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 0 deletions.
diff --git a/docs/_templates/breadcrumbs.html b/docs/_templates/breadcrumbs.html
@@ -0,0 +1,7 @@
+{%- extends "sphinx_rtd_theme/breadcrumbs.html" %}
+
+{% block breadcrumbs_aside %}
+{% if not meta or meta.get('github_url') != 'hide' %}
+{{ super() }}
+{% endif %}
+{% endblock %}
diff --git a/docs/templates/apidoc/module.rst_t b/docs/templates/apidoc/module.rst_t
@@ -1,3 +1,6 @@
+:github_url: hide
+{{"\n"}}
+
 {%- if show_headings %}
 {{- basename | e | heading }}
 

diff --git a/docs/templates/apidoc/package.rst_t b/docs/templates/apidoc/package.rst_t
@@ -1,3 +1,6 @@
+:github_url: hide
+{{"\n"}}
+
 {%- macro automodule(modname, options) -%}
 .. automodule:: {{ modname }}
 {%- for option in options %}

diff --git a/docs/templates/apidoc/toc.rst_t b/docs/templates/apidoc/toc.rst_t
@@ -1,3 +1,6 @@
+:github_url: hide
+{{"\n"}}
+
 {{ header | heading }}
 
 .. toctree::