Merge pull request #436 from tomschr/docs-searchbox

tomschr · web-flow · commit 68d19f59660c · 2023-10-09T19:21:40.000+02:00
Move search box more at the top
diff --git a/changelog.d/pr436.doc.rst b/changelog.d/pr436.doc.rst
@@ -0,0 +1,3 @@
+Move search box more at the top. This makes it easier for
+users as if the TOC is long, the search box isn't visible
+anymore.
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
@@ -31,6 +31,10 @@ div.related.top nav {
     margin-bottom: -0.75em;
 }
 
+#searchbox {
+  margin-bottom: 1.25em;
+}
+
 .section h1 {
     font-weight: 700;
 }
diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
@@ -3,47 +3,8 @@
 #}
 {% extends "!layout.html" %}
 
-{%- block footer %}
-<div class="footer">
-<p>
-  {% if show_copyright %}&copy;{{ copyright }}.{% endif %}
-  {% if theme_show_powered_by|lower == 'true' %}
-  {% if show_copyright %}|{% endif %}
-  {% if show_copyright %}|{% endif %}
-    Powered by <a href="http://sphinx-doc.org/">Sphinx {{ sphinx_version }}</a>
-    &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster {{ alabaster_version }}</a>
-  {% endif %}
-  {%- if show_source and has_source and sourcename %}
-  {% if show_copyright or theme_show_powered_by %}|{% endif %}
-  <a href="{{ pathto('_sources/' + sourcename, true)|e }}"
-          rel="nofollow">{{ _('Page source') }}</a>
-  {%- endif %}
-</p>
-<p>
-  For <a href="https://github.com/{{ theme_github_user }}/{{ theme_github_repo }}"
-  >semver {{ version }}</a>
-</p>
-</div>
 
-{% if theme_github_banner|lower != 'false' %}
-<a href="https://github.com/{{ theme_github_user }}/{{ theme_github_repo }}" class="github">
-    <img style="position: absolute; top: 0; right: 0; border: 0;" src="{{ pathto('_static/' ~ theme_github_banner, 1) if theme_github_banner|lower != 'true' else 'https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png' }}" alt="Fork me on GitHub"  class="github"/>
-</a>
-{% endif %}
-{% if theme_analytics_id %}
-<script type="text/javascript">
-
-  var _gaq = _gaq || [];
-  _gaq.push(['_setAccount', '{{ theme_analytics_id }}']);
-  _gaq.push(['_setDomainName', 'none']);
-  _gaq.push(['_setAllowLinker', true]);
-  _gaq.push(['_trackPageview']);
-
-  (function() {
-    var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
-    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
-    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
-  })();
-  </script>
-{% endif %}
-{%- endblock %}
+{%- block extrahead %}
+  {{- super() }}
+  <meta name="generator" content="Toms"/>
+{% endblock %}
diff --git a/docs/conf.py b/docs/conf.py
@@ -211,6 +211,16 @@ def find_version(*file_paths):
 html_static_path = ["_static"]
 html_css_files = ["css/custom.css"]
 
+html_sidebars = {
+    "**": [
+        "about.html",  # theme_logo
+        # 'relations.html',  # prev and next
+        "searchbox.html",  # basic/searchbox.html
+        "navigation.html",  # TOC
+        # 'donate.html',
+    ]
+}
+
 # Canonical link relation
 if os.environ.get("READTHEDOCS_CANONICAL_URL"):
     html_baseurl = f"{os.environ['READTHEDOCS_CANONICAL_URL']}"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Move search box more at the top. This makes it easier for`
	`2`	`+users as if the TOC is long, the search box isn't visible`
	`3`	`+anymore.`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,10 @@ div.related.top nav {`
`31`	`31`	`margin-bottom: -0.75em;`
`32`	`32`	`}`
`33`	`33`
	`34`	`+#searchbox {`
	`35`	`+ margin-bottom: 1.25em;`
	`36`	`+}`
	`37`	`+`
`34`	`38`	`.section h1 {`
`35`	`39`	`font-weight: 700;`
`36`	`40`	`}`