reorg homepage, pin theme version to 0.4.2 for now

mne-tools · Jan 22, 2021 · 7b75c04 · 7b75c04
1 parent 39081b9
commit 7b75c04
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 51 deletions.
diff --git a/doc/_static/style.css b/doc/_static/style.css
@@ -1,36 +1,42 @@
 :root {
 
+    --font-size-base: 16px;
+    --font-size-milli: 13px;
     --font-family-base: 'Source Sans Pro', sans-serif;
-    --font-family-heading: 'Source Sans Pro', sans-serif;
+    --font-family-heading: var(--font-family-base);
+    --font-family-monospace: 'Source Code Pro', monospace;
 
     --carousel-radius: 12px;
 
 }
 
-/* ***************************** devbar (alert for development version docs) */
+/* ******** devbox (alert for development version docs) and version dropdown */
 .devbox a {
     font-weight: bold;
     color: var(--color-danger);
 }
-
 .dropdown {
     margin-left: 10px;
 }
+.dropdown-toggle {
+    font-weight: 600;
+}
 
 /* ********************************************************** Sphinx-gallery */
 
-/* backreference links */
+/* backreference links: restore hover decoration that SG removes */
 a.sphx-glr-backref-instance:hover {
-    text-decoration: underline;  /* restore hover decoration that SG removes */
+    text-decoration: underline;
 }
+/* backreference links: make non-MNE func/meth calls resemble regular code */
 a[class^="sphx-glr-backref-module"] {
-    color: var(--color-text-base);  /* make non-MNE instances resemble regular code */
+    color: var(--color-text-base);
 }
+/* backreference links: make MNE calls bold and colorful */
 a[class^="sphx-glr-backref-module-mne"] {
-    font-weight: 600;  /* make all MNE things bold */
+    font-weight: 600;
     color: var(--color-link);
 }
-
 /* suppress redundant note at top of every tutorial and signature at the end */
 div.sphx-glr-download-link-note,
 p.sphx-glr-signature {
@@ -39,7 +45,6 @@ p.sphx-glr-signature {
     margin: 0;
     padding: 0;
 }
-
 /* Report embedding */
 iframe.sg_report {
     width: 95%;
@@ -59,7 +64,8 @@ div[id^="examples-using-"] h2 {
 
 /* ******************************************* in-text sidebar callout boxes */
 div.sidebar {
-    background-color: rgba(23, 162, 184, 0.1);  /* transparent version of --info color */
+    /* transparent version of --info color */
+    background-color: rgba(23, 162, 184, 0.1);
     border: 1px solid var(--info);
     border-radius: 4px;
 }
@@ -116,7 +122,6 @@ img.institution {
 }
 
 /* ***************************************************** front page carousel */
-
 div.slide {
     border-radius: var(--carousel-radius);
     overflow: hidden;

diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html
@@ -7,6 +7,7 @@
     <!-- or add a `style` tag with a font fallback chain with good cross-platform coverage -->
     <style>
         body,h1,h2,h3,h4,h5,h6 {font-family: 'Source Sans Pro', sans-serif;}
+        code,kbd,pre,samp {font-family: 'Source Code Pro', monospace;}
     </style>
 {% endblock %}
 

diff --git a/doc/_templates/sidebar-whats-new.html b/doc/_templates/sidebar-whats-new.html
@@ -0,0 +1,14 @@
+
+<div class="card mt-4">
+    <h5 class="card-header {% if build_dev_html|tobool %} devbox alert alert-danger {% endif %}">Version {{ release }}</h5>
+    <div class="card-body">
+        <ul class="list-group list-group-flush version-box">
+            <li><i class="fas fa-newspaper fa-fw"></i> <a href="{{ pathto('whats_new.html', 1) }}">Changelog</a></li>
+            <li><i class="fas fa-book fa-fw"></i> <a href="{{ pathto('overview/index.html', 1) }}">Documentation</a></li>
+            <li><i class="fas fa-question-circle fa-fw"></i> <a href="{{ pathto('overview/get_help.html', 1) }}">Get help</a></li>
+            <li><i class="fas fa-quote-left fa-fw"></i> <a href="{{ pathto('overview/cite.html', 1) }}">Cite</a></li>
+            <li><i class="fas fa-code-branch fa-fw"></i> <a href="{{ pathto('install/contributing.html', 1) }}">Contribute</a></li>
+
+        </ul>
+    </div>
+</div>
diff --git a/doc/conf.py b/doc/conf.py
@@ -491,8 +491,8 @@ def append_attr_meth_examples(app, what, name, obj, options, lines):
 
 # Custom sidebar templates, maps document names to template names.
 html_sidebars = {
-    '**': ['sidebar-dev-version.html', 'sidebar-nav-bs.html'],
-    'index': ['sidebar-dev-version.html'],
+    'index': [],
+    'overview/index': []
 }
 
 # If true, links to the reST sources are added to the pages.

diff --git a/doc/index.rst b/doc/index.rst
@@ -25,34 +25,6 @@ analyzing human neurophysiological data: MEG, EEG, sEEG, ECoG, NIRS, and more.
 
 .. include:: carousel.inc
 
-
-.. SIDEBAR (WHAT'S NEW)
-
-.. raw:: html
-
-  <div class="card mt-4">
-    <h5 class="card-header">
-
-Version |version|
-
-.. raw:: html
-
-    </h5>
-    <div class="card-body">
-
-.. rst-class:: list-group list-group-flush version-box
-
-- |fw-newspaper| :ref:`Changelog <whats_new>`
-- |fw-book| :ref:`Documentation <documentation_overview>`
-- |fw-question-circle| :ref:`Get help <help>`
-- |fw-quote-left| :ref:`Cite <cite>`
-- |fw-code-branch| :ref:`Contribute <contributing>`
-
-.. raw:: html
-
-    </div>
-  </div>
-
 .. SIDEBAR (FUNDERS)
 
 .. raw:: html

diff --git a/doc/overview/index.rst b/doc/overview/index.rst
@@ -58,12 +58,3 @@ Documentation for the related C and MATLAB tools are available here:
 
 - :ref:`MNE-MATLAB <mne_matlab>` (HTML)
 - `MNE-C <MNE-C manual_>`_ (PDF)
-
-
-.. toctree::
-   :hidden:
-
-   Tutorials<../auto_tutorials/index>
-   Examples<../auto_examples/index>
-   ../glossary
-   API<../python_reference>
diff --git a/requirements_doc.txt b/requirements_doc.txt
@@ -1,7 +1,7 @@
 sphinx
 numpydoc
 sphinx_fontawesome
-pydata_sphinx_theme
+pydata_sphinx_theme==0.4.2
 sphinx-gallery
 sphinxcontrib-bibtex>=2.1.2
 memory_profiler