add manual.pdf CITATION.CFF makefile...

Remi-Gau · Remi-Gau · commit dc875b444468 · 2022-11-02T11:17:21.000+01:00
diff --git a/.zenodo.json b/.zenodo.json
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,56 @@
+cff-version: 1.2.0
+
+title: "CPP PTB"
+
+version: 1.2.1dev
+
+abstract: a set of function to make it easier to create behavioral, EEG, fMRI experiment with psychtoolbox .
+
+message: "If you use this software, please cite it as below."
+
+repository-code: "https://github.com/cpp-lln-lab/CPP_PTB"
+
+identifiers:
+  - description: This is the collection of archived snapshots of all releases of CPP PTB
+    type: doi
+    value: "10.5281/zenodo.4007672"
+
+contact:
+  - affiliation: "Université catholique de Louvain"
+    email: remi.gau@uclouvain.be
+    family-names: Gau
+    given-names: Rémi
+
+authors:
+- family-names: "Gau"
+  given-names: "Rémi"
+  orcid: "https://orcid.org/0000-0002-1535-9767"
+  affiliation: "Université catholique de Louvain"
+
+- family-names: "Barilari"
+  given-names: "Marco"
+  orcid: "https://orcid.org/0000-0002-3313-3120"
+  affiliation: "Université catholique de Louvain"
+
+- family-names: "Battal"
+  given-names: "Ceren"
+  orcid: "https://orcid.org/0000-0002-9844-7630"
+  affiliation: "Université catholique de Louvain"
+
+- family-names: "Falagiarda"
+  given-names: "Federica"
+  orcid: "https://orcid.org/0000-0001-7844-1605"
+  affiliation: "Université catholique de Louvain"
+
+- family-names: "Shahzad"
+  given-names: "Iqra"
+  orcid: "https://orcid.org/0000-0002-8724-7668"
+  affiliation: "Université catholique de Louvain"
+
+license: MIT license
+
+keywords:
+  - PsychToolBox
+  - neuroscience
+  - MATLAB
+  - Octave
diff --git a/Makefile b/Makefile
@@ -0,0 +1,18 @@
+# TODO make more general to use the local matlab version
+MATLAB = /usr/local/MATLAB/R2017a/bin/matlab
+ARG    = -nodisplay -nosplash -nodesktop
+
+lint:
+	mh_style --fix && mh_metric --ci && mh_lint
+
+test:
+	$(MATLAB) $(ARG) -r "runTests; exit()"
+
+version.txt: CITATION.cff
+	grep -w "^version" CITATION.cff | sed "s/version: /v/g" > version.txt
+
+validate_cff: CITATION.cff
+	cffconvert --validate
+
+manual:
+	cd docs && sh create_manual.sh
diff --git a/docs/Makefile b/docs/Makefile
@@ -18,6 +18,3 @@ help:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-doc:
-	@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)"
diff --git a/docs/cpp_ptb-manual.pdf b/docs/cpp_ptb-manual.pdf
diff --git a/docs/create_manual.sh b/docs/create_manual.sh
@@ -0,0 +1,5 @@
+#!/bin/bash
+
+sphinx-build -M latexpdf source build
+
+cp build/latex/cpp_ptb.pdf cpp_ptb-manual.pdf
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -21,7 +21,7 @@
 author = 'CPP_PTB developers'
 
 # The full version, including alpha/beta/rc tags
-release = 'v1.2.1'
+release = 'v1.2.1dev'
 
 
 # -- General configuration ---------------------------------------------------
