Merge pull request #1217 from nipreps/doc/add-changes

DOC: Add changelog to documentation
nipreps · Mar 22, 2024 · 5d5b1ef · 5d5b1ef
2 parents 61b59e0 + b53fd99
commit 5d5b1ef
Show file tree

Hide file tree

Showing 11 changed files with 22 additions and 12 deletions.
diff --git a/docs/source/about.rst b/docs/source/about.rst
@@ -1,4 +1,5 @@
 Introduction
-============
+************
+
 .. include:: ../../README.rst
    :start-line: 3
diff --git a/docs/source/changes.rst b/docs/source/changes.rst
@@ -0,0 +1,4 @@
+What's new
+**********
+
+.. include:: ../../CHANGES.rst
diff --git a/docs/source/docker.rst b/docs/source/docker.rst
@@ -2,7 +2,7 @@
 .. _docker:
 
 Run mriqc with docker
-=====================
+*********************
 Preliminaries
 -------------
 #. Get the Docker Engine (https://docs.docker.com/engine/installation/)

diff --git a/docs/source/dsa.rst b/docs/source/dsa.rst
@@ -2,7 +2,7 @@
 .. _dsa:
 
 Data Sharing Agreement
-======================
+**********************
 Foundations
 -----------
 (Text in this section has been retrieved from https://www.ihris.org/toolkit/tools/data-sharing.html)

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,12 +1,14 @@
 Welcome to *MRIQC*'s documentation!
-===================================
+###################################
+
 .. include:: ../../README.rst
    :start-line: 3
 
 .. image :: _static/OHBM2017-poster.png
 
 Contents
 --------
+
 .. toctree::
    :maxdepth: 3
 
@@ -19,9 +21,10 @@ Contents
    workflows
    dsa
    license
+   changes
 
 Indices and tables
-==================
+------------------
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
diff --git a/docs/source/install.rst b/docs/source/install.rst
@@ -1,6 +1,6 @@
 
 Installation
-============
+************
 Containerized versions
 ----------------------
 If you have Docker installed, the quickest way to get ``mriqc`` to work

diff --git a/docs/source/license.rst b/docs/source/license.rst
@@ -1,5 +1,5 @@
 About the *NiPreps* framework licensing
-=======================================
+***************************************
 Please check https://www.nipreps.org/community/licensing/ for detailed
 information on the criteria we use to license *MRIQC* and other
 projects of the framework.

diff --git a/docs/source/measures.rst b/docs/source/measures.rst
@@ -2,7 +2,8 @@
 .. _measures:
 
 Image Quality Metrics (IQMs)
-============================
+****************************
+
 .. automodule:: mriqc.qc
     :members:
     :undoc-members:

diff --git a/docs/source/reports.rst b/docs/source/reports.rst
@@ -2,7 +2,7 @@
 .. _reports:
 
 Visual Reports
-==============
+**************
 Demo: anatomical reports
 ------------------------
 .. raw:: html

diff --git a/docs/source/running.rst b/docs/source/running.rst
@@ -1,8 +1,8 @@
 
 .. _running_mriqc:
 
-Running mriqc
-=============
+Running *MRIQC*
+***************
 .. tip::
      Try MRIQC online on `OpenNeuro <https://www.openneuro.org/>`_ - without
      installation!

diff --git a/docs/source/workflows.rst b/docs/source/workflows.rst
@@ -2,7 +2,8 @@
 .. _workflows:
 
 Workflows
-=========
+*********
+
 .. automodule:: mriqc.workflows
     :members:
     :undoc-members: