fix related software list & disable auto-sort

Author: drammock

.pre-commit-config.yaml

@@ -79,7 +79,7 @@ repos:
     rev: v6.0.0
     hooks:
       - id: file-contents-sorter
-        files: ^doc/sphinxext/related_software.txt|^ignore_words.txt
+        files: ^ignore_words.txt
         args: ["--ignore-case"]
 
   - repo: https://github.com/pappasam/toml-sort

doc/sphinxext/related_software.txt

@@ -1,44 +1,47 @@
+# This file is used to install extra packages into CircleCI when building our docs.
+# The purpose is to allow the packages in the "related software" list to be introspected
+# so we can get their URLs and Summary descriptions automatically.
+# Related software with onerous dependencies (e.g., torch and tensorflow)
+# should be added to `related_software_nodeps.txt` instead.
+# Ideally each package should be tagged as one or more of the following categories;
+# packages with no tags will be categorized as "Other".
+# Make sure to put categories at the END of the line, separated by commas if a package
+# fits in multiple categories.
 #
-#
-#
+# LIST OF CATEGORIES
 # ==================
-# =========================================
-# ==========================================================================
-# antio  # categories: Data I/O and interoperability
-# best-python # categories: Data I/O and interoperability
-# Connectivity and source analysis
 # Connectivity and source analysis
 # Data I/O and interoperability
 # Data organization and workflows
+# Microstates and neural states
+# Oscillations and time-frequency analysis
+# Other physiological signals and modalities
+# Preprocessing and artifact correction
+# Statistics and machine learning
+# Visualization and real-time analysis
+#
+# MNE-PYTHON OPTIONAL DEPENDENCIES THAT WE ALSO WANT IN THE CATEGORIZED LIST
+# ==========================================================================
+# antio  # categories: Data I/O and interoperability
+# best-python # categories: Data I/O and interoperability
 # dipy # categories: Other physiological signals and modalities
-# Each package should be related to one or several of the following categories.
 # edfio # categories: Data I/O and interoperability
 # eeglabio # categories: Data I/O and interoperability
-# LIST OF CATEGORIES
-# Microstates and neural states
-# Microstates and neural states
 # mne-bids  # categories: Data organization and workflows
 # mne-connectivity # categories: Connectivity and source analysis
 # mne-gui-addons # categories: Visualization and real-time analysis
-# MNE-PYTHON OPTIONAL DEPENDENCIES THAT WE ALSO WANT IN THE CATEGORIZED LIST
 # mne-qt-browser # categories: Visualization and real-time analysis
 # neo # categories: Data I/O and interoperability, Data organization and workflows
 # nilearn # categories: Statistics and machine learning, Other physiological signals and modalities
-# ONES WE ACTUALLY NEED CIRCLECI TO INSTALL
 # openmeeg # categories: Connectivity and source analysis
 # openneuro-py # categories: Data I/O and interoperability
-# Oscillations and time-frequency analysis
-# Other physiological signals and modalities
 # posthoc # categories: Statistics and machine learning
-# Preprocessing and artifact correction
 # pybv # categories: Data I/O and interoperability
-# related software with onerous dependencies (e.g., torch and tensorflow)
-# should be added to related_software_nodeps.txt
 # snirf # categories: Other physiological signals and modalities
-# Statistics and machine learning
-# Statistics and machine learning
 # surfa # categories: Visualization and real-time analysis, Other physiological signals and modalities
-# Visualization and real-time analysis
+#
+# ONES WE ACTUALLY NEED CIRCLECI TO INSTALL
+# =========================================
 alphaCSC # categories: Statistics and machine learning, Oscillations and time-frequency analysis
 autoreject # categories: Preprocessing and artifact correction
 bycycle # categories: Oscillations and time-frequency analysis