From dba7df1914f020f8905c7be4ae5a0ce823e4e2eb Mon Sep 17 00:00:00 2001 From: Daniel McCloy Date: Thu, 4 May 2023 14:48:46 -0500 Subject: [PATCH] Update website conf (#11675) Co-authored-by: Eric Larson --- doc/_static/style.css | 4 ---- doc/_templates/homepage.html | 4 ++-- doc/_templates/layout.html | 2 +- doc/conf.py | 32 ++++++++++++++++++-------------- doc/index.rst | 2 ++ doc/install/index.rst | 2 ++ doc/overview/cite.rst | 9 ++++++--- doc/overview/migrating.rst | 6 +++--- requirements_doc.txt | 2 +- 9 files changed, 35 insertions(+), 28 deletions(-) diff --git a/doc/_static/style.css b/doc/_static/style.css index b2648b80d6c..8e976e3ffd1 100644 --- a/doc/_static/style.css +++ b/doc/_static/style.css @@ -7,7 +7,6 @@ --pst-font-family-monospace: 'Source Code Pro', var(--pst-font-family-monospace-system); /* colors that aren't responsive to light/dark mode */ --mne-color-discord: #5865F2; - --mne-color-twitter: #55acee; --mne-color-primary: #007bff; --mne-color-primary-highlight: #0063cc; /* font weight */ @@ -209,9 +208,6 @@ aside.footnote:last-child { #navbar-icon-links i.fa-square-github::before { color: var(--mne-color-github); } -#navbar-icon-links i.fa-square-twitter::before { - color: var(--mne-color-twitter); -} #navbar-icon-links i.fa-discourse::before { color: var(--mne-color-discourse); } diff --git a/doc/_templates/homepage.html b/doc/_templates/homepage.html index b960416ced5..3b65c11e59c 100644 --- a/doc/_templates/homepage.html +++ b/doc/_templates/homepage.html @@ -1,8 +1,8 @@
-
+
{% for item in carousel %} -
+
{{ item.alt }} diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html index 8cb76c50fcf..6bb88d43ed1 100644 --- a/doc/_templates/layout.html +++ b/doc/_templates/layout.html @@ -15,6 +15,6 @@ {% endblock %} {%- block scripts_end %} - {{ super() }} + {%- endblock %} diff --git a/doc/conf.py b/doc/conf.py index 39d00c796bb..a3b0f901cca 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -81,27 +81,30 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + # builtin "sphinx.ext.autodoc", "sphinx.ext.autosummary", "sphinx.ext.coverage", "sphinx.ext.doctest", + "sphinx.ext.graphviz", "sphinx.ext.intersphinx", "sphinx.ext.linkcode", "sphinx.ext.mathjax", "sphinx.ext.todo", - "sphinx.ext.graphviz", + # contrib + "matplotlib.sphinxext.plot_directive", "numpydoc", + "sphinx_copybutton", + "sphinx_design", "sphinx_gallery.gen_gallery", + "sphinxcontrib.bibtex", + "sphinxcontrib.youtube", + # homegrown "gen_commands", + "gen_names", "gh_substitutions", "mne_substitutions", "newcontrib_substitutions", - "gen_names", - "matplotlib.sphinxext.plot_directive", - "sphinxcontrib.bibtex", - "sphinx_copybutton", - "sphinx_design", - "sphinxcontrib.youtube", "unit_role", ] @@ -785,20 +788,18 @@ def append_attr_meth_examples(app, what, name, obj, options, lines): ), ], "icon_links_label": "External Links", # for screen reader - "use_edit_page_button": False, + "use_edit_page_button": True, "navigation_with_keys": False, "show_toc_level": 1, + "article_header_start": [], # disable breadcrumbs "navbar_end": ["theme-switcher", "version-switcher", "navbar-icon-links"], "footer_start": ["copyright"], - "footer_end": [], - "secondary_sidebar_items": ["page-toc"], + "secondary_sidebar_items": ["page-toc", "edit-this-page"], "analytics": dict(google_analytics_id="G-5TBCPCRB6X"), "switcher": { "json_url": "https://mne.tools/dev/_static/versions.json", "version_match": switcher_version_match, }, - "pygment_light_style": "default", - "pygment_dark_style": "github-dark", } # The name of an image file (relative to this directory) to place at the top @@ -851,8 +852,11 @@ def append_attr_meth_examples(app, what, name, obj, options, lines): # variables to pass to HTML templating engine html_context = { "default_mode": "auto", - "pygment_light_style": "tango", - "pygment_dark_style": "native", + # next 3 are for the "edit this page" button + "github_user": "mne-tools", + "github_repo": "mne-python", + "github_version": "main", + "doc_path": "doc", "funders": [ dict(img="nih.svg", size="3", title="National Institutes of Health"), dict(img="nsf.png", size="3.5", title="US National Science Foundation"), diff --git a/doc/index.rst b/doc/index.rst index 12295e60aa5..0d17b9bf395 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,3 +1,5 @@ +:html_theme.sidebar_secondary.remove: + .. title:: MNE .. The page title must be in rST for it to show in next/prev page buttons. diff --git a/doc/install/index.rst b/doc/install/index.rst index e4f12a112c6..1c8b7122af9 100644 --- a/doc/install/index.rst +++ b/doc/install/index.rst @@ -1,3 +1,5 @@ +:html_theme.sidebar_secondary.remove: + .. _install: .. _quick-start: diff --git a/doc/overview/cite.rst b/doc/overview/cite.rst index e8be40e1301..5d67fec3ea3 100644 --- a/doc/overview/cite.rst +++ b/doc/overview/cite.rst @@ -7,9 +7,12 @@ Citing the software ------------------- To cite specific version numbers of the software, you can use the DOIs provided -by `Zenodo `_. Additionally, we ask that -when citing the MNE-Python package, you cite the canonical journal article -reference :footcite:`GramfortEtAl2013a`: +by `Zenodo `_; look for the "versions" +list in the sidebar to find the correct DOI for the version you used in your +work (or to cite the project in a general way, use +https://doi.org/10.5281/zenodo.592483). Additionally, we ask that when citing +MNE-Python you also cite the canonical journal article reference +:footcite:`GramfortEtAl2013a`: .. footbibliography:: diff --git a/doc/overview/migrating.rst b/doc/overview/migrating.rst index 4fe4ba3ce4f..9aeb945c418 100644 --- a/doc/overview/migrating.rst +++ b/doc/overview/migrating.rst @@ -86,6 +86,6 @@ Potential pitfalls - The concept of channel types is critical in MNE because it supports analysis of multimodal data (e.g., EEG, MEG, EOG, Stim channel, etc) whereas most EEGLAB functions assume all channels are of the same type (EEG). To restrict - channels to a single type, see :func:`mne.pick_types`, :meth:`raw.pick_types - `, :meth:`epochs.pick_types `, - :meth:`evoked.pick_types `, etc. + channels to a single type, see :func:`mne.pick_types`, + :meth:`raw.pick() `, :meth:`epochs.pick() ` + and :meth:`evoked.pick() `. diff --git a/requirements_doc.txt b/requirements_doc.txt index 180d1699780..41770c78c2b 100644 --- a/requirements_doc.txt +++ b/requirements_doc.txt @@ -1,7 +1,7 @@ # requirements for building docs sphinx!=4.1.0,<6 git+https://github.com/numpy/numpydoc.git@main -pydata_sphinx_theme==0.13.1 +pydata_sphinx_theme==0.13.3 git+https://github.com/sphinx-gallery/sphinx-gallery@master sphinxcontrib-bibtex>=2.5 memory_profiler