Skip to content

Commit 4dc3960

Browse files
committed
DOC: Add 'About MNE-Python' section to website
- Add new top-level 'About' section to the documentation website - Add new overview.rst page describing MNE-Python, its mission, and governance structure (closes #13575) - Move governance.rst from Development to About section - Move whats_new.rst (changelog) from Development to About section - Move cite.rst and cited.rst from Documentation to About section - Move bibliography.rst from orphan to About section
1 parent 6a0ffdf commit 4dc3960

11 files changed

Lines changed: 62 additions & 4 deletions

File tree

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

doc/about/index.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
.. _about:
2+
3+
About MNE-Python
4+
================
5+
6+
7+
.. toctree::
8+
:hidden:
9+
10+
overview
11+
governance
12+
whats_new
13+
bibliography
14+
cite
15+
cited

doc/about/overview.rst

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
.. _overview:
2+
3+
========
4+
Overview
5+
========
6+
7+
About MNE-Python
8+
================
9+
10+
MNE-Python is software for analysis and visualization of human
11+
neuroscience data. The core package emphasizes EEG and MEG modalities,
12+
but extension packages provide enhanced support for
13+
:doc:`fNIRS <mne-nirs:index>` and :doc:`EMG <mne-python:index>`.
14+
Other extensions provide advanced algorithms for
15+
:doc:`connectivity analysis <mne-connectivity:index>`,
16+
:doc:`compatibility with BIDS <mne-bids:index>`,
17+
`integration with LSL for real-time data streams <https://mne.tools/mne-lsl>`__,
18+
:doc:`denoising <mne-noise-reduction:index>`,
19+
and :doc:`many other functionalities <mne-tools:index>`.
20+
All software in the `MNE-tools organization <https://github.com/mne-tools>`__
21+
is open-source and permissively licensed.
22+
23+
Mission
24+
=======
25+
26+
The mission of the MNE-Tools organization is to support neuroscience
27+
research and its application to clinical and commercial uses. This
28+
includes our software tools, but also many forms of user support and
29+
education: :ref:`tutorial resources <tutorials>`,
30+
a `Q&A forum <https://mne.discourse.group>`__,
31+
:ref:`office hours <contributing>`,
32+
:ref:`workshops <contributing>`,
33+
and :ref:`hackathons <contributing>`.
34+
35+
Governance
36+
==========
37+
38+
The MNE project is led by a :ref:`steering council <governance>`,
39+
with guidance from an :ref:`advisory board <governance>`.
40+
Software development is overseen by the :ref:`maintainer team <governance>`,
41+
with :ref:`many contributions from our community of users <contributing>`.
42+
There are also a few :ref:`working groups <governance>`
43+
focused on particular topics.
File renamed without changes.

doc/changes/devel/13908.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
- Add new "About MNE-Python" top-level section to the website, consolidating
2+
governance, changelog, bibliography, citation pages, and a new overview
3+
page (:gh:`13575`). By :ghuser:`Omesh37`.

doc/development/index.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,4 @@ experience.
3333
:hidden:
3434

3535
contributing
36-
whats_new
3736
roadmap
38-
governance

doc/documentation/index.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,5 @@ Documentation for the related C and MATLAB tools are available here:
5757
Command-line tools<../generated/commands>
5858
../help/migrating
5959
cookbook
60-
cite
61-
cited
6260

6361
.. include:: ../links.inc

0 commit comments

Comments
 (0)