From 3cfb1f89f3316523135acadf3e54621acbf596bf Mon Sep 17 00:00:00 2001
From: "Gregoire Malandain (from ross)" <gregoire.malandain@inria.fr>
Date: Fri, 9 Jul 2021 11:38:13 +0200
Subject: [PATCH] update documentation
---
README.md | 4 ++++
doc/source/astec_tutorial.rst | 2 +-
doc/source/conf.py | 2 +-
doc/source/index.rst | 7 ++++---
doc/source/publications.rst | 6 ++++++
5 files changed, 16 insertions(+), 5 deletions(-)
create mode 100644 doc/source/publications.rst
diff --git a/README.md b/README.md
index 1b643a7..0a81c8c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,6 @@
# Astec Tutorial
+This repository contains tutorial data for astec suite (see
+[gitlab.inria.fr/astec/astec](https://gitlab.inria.fr/astec/astecl).
+
+Tutorial documentation can be found at [astec.gitlabpages.inria.fr/astec-tutorial/](https://astec.gitlabpages.inria.fr/astec-tutorial/).
diff --git a/doc/source/astec_tutorial.rst b/doc/source/astec_tutorial.rst
index 7ce0423..7dade3f 100644
--- a/doc/source/astec_tutorial.rst
+++ b/doc/source/astec_tutorial.rst
@@ -113,7 +113,7 @@ done with |fusion|
* The variable ``EN`` is the prefix after which the result fusion
images will be named.
* The variables ``begin`` and ``end`` set respectively the
- first and the last index of the input time points to be processed.
+ first and the last index of the input time points to be processed.
* The variable ``DIR_RAWDATA`` is the directory containing the raw
data.
* The variables ``DIR_LEFTCAM_STACKZERO``,
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 4d45cbe..2c842df 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -68,7 +68,7 @@ rst_prolog = """
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
-html_theme = 'alabaster'
+html_theme = 'sphinxdoc'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 8afc697..0bd13fa 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,6 +1,6 @@
-==============
-Astec tutorial
-==============
+============================
+Welcome to astec's tutorial!
+============================
ASTEC, for **Adaptive Segmentation and Tracking of Embryonic Cells**, was first developed during L. Guignard PhD thesis :cite:p:`guignard:tel-01278725`.
@@ -14,5 +14,6 @@ Its development has been pursued, and it was used to process 3D+t movies acquire
installation.rst
astec_tutorial.rst
+ publications.rst
diff --git a/doc/source/publications.rst b/doc/source/publications.rst
new file mode 100644
index 0000000..35a4a60
--- /dev/null
+++ b/doc/source/publications.rst
@@ -0,0 +1,6 @@
+Publications & bibliography
+===========================
+
+.. bibliography::
+ :all:
+
--
GitLab