Skip to content

Commit 88df35f

Browse files
drammockdrammock
authored
DOC: more website fixes (#9202)
* quicklinks docs → tutorials * move funders to dedicated page * overhaul funders/institutions handling * don't use inst logos as bullets (shapes too varied) * tweak title, fix apostrophe * remove funders from quicklinks * fix sticky sidebars * tweak spacing [skip azp][skip github][circle front] * fix codespell [skip github][skip azp][circle front]
1 parent 98fb5c2 commit 88df35f

File tree

7 files changed

+143
-84
lines changed

7 files changed

+143
-84
lines changed

‎doc/_static/style.css‎

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -83,22 +83,24 @@ img.logo {
8383
width: 100%;
8484
}
8585

86-
/* ************************************** homepage quick links & funders box */
86+
/* ************************************* homepage quick links & funders list */
8787
ul.quicklinks {
8888
font-weight: 600;
8989
}
9090
ul.quicklinks a:hover {
9191
text-decoration: none;
9292
}
9393
ul.funders li {
94-
line-height: initial;
95-
margin-left: 24px;
96-
text-indent: -24px;
97-
padding-bottom: 6px;
94+
margin-left: 36px;
95+
text-indent: -36px;
96+
padding-bottom: 9px;
9897
}
9998
ul.funders li img {
100-
width: 18px;
99+
width: 30px;
100+
max-height: 24px;
101+
object-fit: contain;
101102
}
103+
102104
/* these two also affect collapsible divs */
103105
h5.card-header {
104106
margin-top: 0px;
@@ -122,20 +124,6 @@ h5.card-header::before {
122124
margin-left: 15px; /* match other items in the hamburger menu */
123125
}
124126

125-
/* ********************************************* institution logos in footer */
126-
img.institution {
127-
vertical-align: middle;
128-
max-height: 42px;
129-
max-width: 52px;
130-
}
131-
/* prevent footer from getting pushed offscreen */
132-
.bd-sidebar {
133-
height: unset;
134-
}
135-
.bd-toc {
136-
height: unset;
137-
}
138-
139127
/* ***************************************************** front page carousel */
140128
div.frontpage-gallery {
141129
overflow: hidden;

‎doc/_templates/docs-toc.html‎

Lines changed: 0 additions & 17 deletions
This file was deleted.

‎doc/_templates/layout.html‎

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,24 +38,41 @@ <h5 class="card-title fadeout">{{ item.title }}</h5>
3838
{% endfor %}
3939
</div>
4040
</div>
41+
<!-- funders -->
42+
<div class="container">
43+
<p class="h4 text-center font-weight-light mt-4 mt-lg-5">Funders</p>
44+
</div>
45+
<div class="d-flex flex-wrap flex-row justify-content-center align-items-center">
46+
{% for item in funders -%}
47+
<div class="card my-1 mx-2 border-light" style="{{ 'width: ' + item.size + 'rem;' }}">
48+
<a href="{{ pathto('funding.html', 1) }}">
49+
<img class="card-img" src="{{ pathto('_static/funding/' + item.img, 1) }}" title="{{ item.title }}" alt="{{ item.title }}">
50+
</a>
51+
</div>
52+
{% endfor %}
53+
</div>
54+
<!-- institutions -->
55+
<p class="h4 text-center font-weight-light mt-4 mt-lg-5">Supporting institutions</p>
56+
<div class="container">
57+
<div class="d-flex flex-wrap flex-row justify-content-center align-items-center">
58+
{% for inst in institutions -%}
59+
<div class="card my-1 mx-2 border-light" style="{{ 'width: ' + inst.size + 'rem;' }}">
60+
<a href="{{ inst.url }}">
61+
<img class="card-img" src="{{ pathto('_static/institution_logos/' + inst.img, 1) }}" title="{{ inst.name }}" alt="{{ inst.name }}"/>
62+
</a>
63+
</div>
64+
{% endfor %}
65+
</div>
66+
</div>
67+
4168
{% endif %}
4269
</div>
4370
{% endblock %}
4471

72+
4573
<!-- footer -->
4674
{%- block footer %}
4775
<footer class="footer mt-5 mt-md-0">
48-
<div class="container institutions">
49-
<div class="d-flex flex-wrap flex-row justify-content-center">
50-
{% for inst in institutions -%}
51-
<div class="m-2">
52-
<a href="{{ inst.url }}">
53-
<img class="institution" src="{{ pathto('_static/institution_logos/' + inst.img, 1) }}" title="{{ inst.name }}" alt="{{ inst.name }}"/>
54-
</a>
55-
</div>
56-
{% endfor %}
57-
</div>
58-
</div>
5976
<p class="text-center text-muted small">&copy; Copyright {{ copyright }}</p>
6077
</footer>
6178
<script src="https://mne.tools/versionwarning.js"></script>

‎doc/_templates/sidebar-funders.html‎

Lines changed: 0 additions & 17 deletions
This file was deleted.

‎doc/_templates/sidebar-quicklinks.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<h5 class="card-header font-weight-bold">Version {{ release }}</h5>
33
<div class="card-body">
44
<ul class="list-group list-group-flush list-unstyled quicklinks">
5-
<li><a href="{{ pathto('overview/index.html', 1) }}"><i class="text-muted fas fa-book fa-fw"></i> Docs</a></li>
5+
<li><a href="{{ pathto('auto_tutorials/index.html', 1) }}"><i class="text-muted fas fa-book fa-fw"></i> Tutorials</a></li>
66
<li><a href="{{ pathto('whats_new.html', 1) }}"><i class="text-muted fas fa-newspaper fa-fw"></i> Changelog</a></li>
77
<li><a href="{{ pathto('overview/get_help.html', 1) }}"><i class="text-muted fas fa-question-circle fa-fw"></i> Get help</a></li>
88
<li><a href="{{ pathto('overview/cite.html', 1) }}"><i class="text-muted fas fa-quote-left fa-fw"></i> Cite</a></li>

‎doc/conf.py‎

Lines changed: 56 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -538,6 +538,12 @@ def append_attr_meth_examples(app, what, name, obj, options, lines):
538538
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
539539
html_show_sphinx = False
540540

541+
# accommodate different logo shapes (width values in rem)
542+
xs = '2'
543+
sm = '2.5'
544+
md = '3'
545+
lg = '4.5'
546+
xl = '5'
541547
# variables to pass to HTML templating engine
542548
html_context = {
543549
'build_dev_html': bool(int(os.environ.get('BUILD_DEV_HTML', False))),
@@ -556,61 +562,93 @@ def append_attr_meth_examples(app, what, name, obj, options, lines):
556562
'0.12': 'v0.12',
557563
'0.11': 'v0.11',
558564
},
565+
'funders': [
566+
dict(img='nih.png', size='3', title='National Institutes of Health'),
567+
dict(img='nsf.png', size='3.5',
568+
title='US National Science Foundation'),
569+
dict(img='erc.svg', size='3.5', title='European Research Council'),
570+
dict(img='doe.svg', size='3', title='US Department of Energy'),
571+
dict(img='anr.svg', size='4.5',
572+
title='Agence Nationale de la Recherche'),
573+
dict(img='cds.png', size='2.25',
574+
title='Paris-Saclay Center for Data Science'),
575+
dict(img='google.svg', size='2.25', title='Google'),
576+
dict(img='amazon.svg', size='2.5', title='Amazon'),
577+
dict(img='czi.svg', size='2.5', title='Chan Zuckerberg Initiative'),
578+
],
559579
'institutions': [
560580
dict(name='Massachusetts General Hospital',
561581
img='MGH.svg',
562-
url='https://www.massgeneral.org/'),
582+
url='https://www.massgeneral.org/',
583+
size=sm),
563584
dict(name='Athinoula A. Martinos Center for Biomedical Imaging',
564585
img='Martinos.png',
565-
url='https://martinos.org/'),
586+
url='https://martinos.org/',
587+
size=md),
566588
dict(name='Harvard Medical School',
567589
img='Harvard.png',
568-
url='https://hms.harvard.edu/'),
590+
url='https://hms.harvard.edu/',
591+
size=sm),
569592
dict(name='Massachusetts Institute of Technology',
570593
img='MIT.svg',
571-
url='https://web.mit.edu/'),
594+
url='https://web.mit.edu/',
595+
size=md),
572596
dict(name='New York University',
573597
img='NYU.png',
574-
url='https://www.nyu.edu/'),
598+
url='https://www.nyu.edu/',
599+
size=xs),
575600
dict(name='Commissariat à l´énergie atomique et aux énergies alternatives', # noqa E501
576601
img='CEA.png',
577-
url='http://www.cea.fr/'),
602+
url='http://www.cea.fr/',
603+
size=md),
578604
dict(name='Aalto-yliopiston perustieteiden korkeakoulu',
579605
img='Aalto.svg',
580-
url='https://sci.aalto.fi/'),
606+
url='https://sci.aalto.fi/',
607+
size=md),
581608
dict(name='Télécom ParisTech',
582609
img='Telecom_Paris_Tech.png',
583-
url='https://www.telecom-paris.fr/'),
610+
url='https://www.telecom-paris.fr/',
611+
size=md),
584612
dict(name='University of Washington',
585613
img='Washington.png',
586-
url='https://www.washington.edu/'),
614+
url='https://www.washington.edu/',
615+
size=md),
587616
dict(name='Institut du Cerveau et de la Moelle épinière',
588617
img='ICM.jpg',
589-
url='https://icm-institute.org/'),
618+
url='https://icm-institute.org/',
619+
size=md),
590620
dict(name='Boston University',
591621
img='BU.svg',
592-
url='https://www.bu.edu/'),
622+
url='https://www.bu.edu/',
623+
size=lg),
593624
dict(name='Institut national de la santé et de la recherche médicale',
594625
img='Inserm.svg',
595-
url='https://www.inserm.fr/'),
626+
url='https://www.inserm.fr/',
627+
size=xl),
596628
dict(name='Forschungszentrum Jülich',
597629
img='Julich.svg',
598-
url='https://www.fz-juelich.de/'),
630+
url='https://www.fz-juelich.de/',
631+
size=xl),
599632
dict(name='Technische Universität Ilmenau',
600633
img='Ilmenau.gif',
601-
url='https://www.tu-ilmenau.de/'),
634+
url='https://www.tu-ilmenau.de/',
635+
size=xl),
602636
dict(name='Berkeley Institute for Data Science',
603637
img='BIDS.png',
604-
url='https://bids.berkeley.edu/'),
638+
url='https://bids.berkeley.edu/',
639+
size=lg),
605640
dict(name='Institut national de recherche en informatique et en automatique', # noqa E501
606641
img='inria.png',
607-
url='https://www.inria.fr/'),
642+
url='https://www.inria.fr/',
643+
size=xl),
608644
dict(name='Aarhus Universitet',
609645
img='Aarhus.png',
610-
url='https://www.au.dk/'),
646+
url='https://www.au.dk/',
647+
size=xl),
611648
dict(name='Karl-Franzens-Universität Graz',
612649
img='Graz.jpg',
613-
url='https://www.uni-graz.at/'),
650+
url='https://www.uni-graz.at/',
651+
size=md),
614652
],
615653
'carousel': [
616654
dict(title='Source Estimation',

‎doc/funding.rst‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
:orphan:
2+
3+
Funding and other support
4+
=========================
5+
6+
Development of MNE-Python has been supported by:
7+
8+
.. rst-class:: list-unstyled funders
9+
10+
- |nih| **National Institutes of Health:** R01-EB009048, R01-EB009048, R01-EB006385, R01-HD40712, R01-NS44319, R01-NS37462, R01-NS104585, P41-EB015896, P41-RR14075-06
11+
- |nsf| **US National Science Foundation:** 0958669, 1042134
12+
- |erc| **European Research Council:** YStG-263584, YStG-676943
13+
- |doe| **US Department of Energy:** DE-FG02-99ER62764 (MIND)
14+
- |anr| **Agence Nationale de la Recherche:** `14-NEUC-0002-01 <https://anr.fr/Project-ANR-14-NEUC-0002>`_, **IDEX** Paris-Saclay `11-IDEX-0003-02 <https://anr.fr/ProjetIA-11-IDEX-0003>`_
15+
- |cds| **Paris-Saclay Center for Data Science:** `PARIS-SACLAY <http://www.datascience-paris-saclay.fr>`_
16+
- |goo| **Google:** Summer of code (×6)
17+
- |ama| **Amazon:** AWS Research Grants
18+
- |czi| **Chan Zuckerberg Initiative:** `EOSS2 <https://chanzuckerberg.com/eoss/proposals/improving-usability-of-core-neuroscience-analysis-tools-with-mne-python>`_
19+
20+
21+
Additionally, many universities or research institutions have supported their employees’ contributions to MNE-Python as part of normal work duties. These institutions are:
22+
23+
- `Massachusetts General Hospital <https://www.massgeneral.org/>`_
24+
- `Athinoula A. Martinos Center for Biomedical Imaging <https://martinos.org/>`_
25+
- `Harvard Medical School <https://hms.harvard.edu/>`_
26+
- `Massachusetts Institute of Technology <https://web.mit.edu/>`_
27+
- `New York University <https://www.nyu.edu/>`_
28+
- `Commissariat à l’énergie atomique et aux énergies alternatives <http://www.cea.fr/>`_
29+
- `Aalto-yliopiston perustieteiden korkeakoulu <https://sci.aalto.fi/>`_
30+
- `Télécom ParisTech <https://www.telecom-paris.fr/>`_
31+
- `University of Washington <https://www.washington.edu/>`_
32+
- `Institut du Cerveau et de la Moelle épinière <https://icm-institute.org/>`_
33+
- `Boston University <https://www.bu.edu/>`_
34+
- `Institut national de la santé et de la recherche médicale <https://www.inserm.fr/>`_
35+
- `Forschungszentrum Jülich <https://www.fz-juelich.de/>`_
36+
- `Technische Universität Ilmenau <https://www.tu-ilmenau.de/>`_
37+
- `Berkeley Institute for Data Science <https://bids.berkeley.edu/>`_
38+
- `Institut national de recherche en informatique et en automatique <https://www.inria.fr/>`_
39+
- `Aarhus Universitet <https://www.au.dk/>`_
40+
- `Karl-Franzens-Universität Graz <https://www.uni-graz.at/>`_
41+
42+
.. |nih| image:: _static/funding/nih.png
43+
.. |nsf| image:: _static/funding/nsf.png
44+
.. |erc| image:: _static/funding/erc.svg
45+
.. |doe| image:: _static/funding/doe.svg
46+
.. |anr| image:: _static/funding/anr.svg
47+
.. |cds| image:: _static/funding/cds.png
48+
.. |goo| image:: _static/funding/google.svg
49+
.. |ama| image:: _static/funding/amazon.svg
50+
.. |czi| image:: _static/funding/czi.svg

0 commit comments

Comments
 (0)