[DOC] add changelog (#1056)

Remi-Gau · web-flow · commit c514d1f212df · 2023-06-19T14:24:58.000+02:00
* add changelog

* update doc

* update changelog
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/docs/bidspm-manual.pdf b/docs/bidspm-manual.pdf
diff --git a/docs/source/CHANGELOG.md b/docs/source/CHANGELOG.md
@@ -0,0 +1 @@
+../../CHANGELOG.md
diff --git a/docs/source/FAQ.md b/docs/source/FAQ.md
@@ -950,7 +950,7 @@ bids.util.tsvwrite(fullfile(pwd, 'new_events.tsv'), new_content);
 <a name="statistics:-how-should-i-name-my-conditions-in-my-eventstsv"></a>
 ## Statistics: How should I name my conditions in my events.tsv?
 
-In BIDS conditions should be named in the `trial_type` column of the `events.tsv` file.
+In BIDS format, conditions should be named in the `trial_type` column of the `events.tsv` file.
 
 Some good practices for naming "things" can probably be applied here.
 
@@ -975,7 +975,7 @@ So for example:
 
 If your BIDS dataset has conditions that do not follow this rule,
 then you can use
-the [`Replace` variable transform](https://github.com/bids-standard/variable-transform/blob/main/spec/munge.md#replace )
+the [`Replace` variable transform](https://github.com/bids-standard/variable-transform/blob/main/spec/munge.md#replace)
 in your [BIDS statistical model](https://bidspm.readthedocs.io/en/latest/bids_stats_model.html#transformation')
 to rename them on the fly without having to manually edit potentially dozens of files.
 
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -53,7 +53,7 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ["examples", "defaults", "demo", "images/*.md"]
 
-suppress_warnings = ["myst.header"]
+suppress_warnings = ["myst.header", "myst.xref_missing"]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"
diff --git a/docs/source/demos.rst b/docs/source/demos.rst
@@ -47,7 +47,6 @@ This is based on the event related design dataset of SPM.
 .. autoscript:: face_rep_01_anat_only
 .. autoscript:: face_rep_02_stats
 .. autoscript:: face_rep_03_roi_analysis
-.. autoscript:: face_rep_resolution
 
 
 Visual motion localizers
diff --git a/docs/source/dev_doc.rst b/docs/source/dev_doc.rst
@@ -60,6 +60,8 @@ workflows stats
 .. autofunction:: src.workflows.stats.bidsRFX
 .. _bidsResults:
 .. autofunction:: src.workflows.stats.bidsResults
+.. _bidsSmoothContrasts:
+.. autofunction:: src.workflows.stats.bidsSmoothContrasts
 
 
 .. _workflows preproc:
@@ -274,6 +276,8 @@ bids
 .. autofunction:: src.bids.addStcToQuery
 .. _buildIndividualSpaceRoiFilename:
 .. autofunction:: src.bids.buildIndividualSpaceRoiFilename
+.. _checkColumnParticipantsTsv:
+.. autofunction:: src.bids.checkColumnParticipantsTsv
 .. _checkFmriprep:
 .. autofunction:: src.bids.checkFmriprep
 .. _fileFilterForBold:
@@ -370,6 +374,8 @@ defaults
 .. autofunction:: src.defaults.set_spm_2_bids_defaults
 .. _spm_my_defaults:
 .. autofunction:: src.defaults.spm_my_defaults
+.. _validateResultsStructure:
+.. autofunction:: src.defaults.validateResultsStructure
 
 
 .. _infra:
@@ -556,6 +562,8 @@ stats subject_level
 
 stats group_level
 =================
+.. _computeCumulativeFwhm:
+.. autofunction:: src.stats.group_level.computeCumulativeFwhm
 .. _findSubjectConImage:
 .. autofunction:: src.stats.group_level.findSubjectConImage
 .. _getRFXdir:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -28,6 +28,7 @@ Welcome to bidspm documentation!
    quality_analysis
    mancoreg
    docker
+   CHANGELOG
    links_and_references
    dev_doc
 
