From 53f521d588ba6d842cf1f957eb09744b4d58a36e Mon Sep 17 00:00:00 2001 From: Flavio Tarsetti <flavio.tarsetti@idiap.ch> Date: Thu, 7 Jun 2018 15:09:15 +0200 Subject: [PATCH] [doc] fix doc extra markers --- doc/algorithms.rst | 3 ++- doc/api.rst | 3 ++- doc/backend_api.rst | 3 ++- doc/databases.rst | 3 ++- doc/dataformats.rst | 3 ++- doc/develop.rst | 3 ++- doc/experiments.rst | 3 ++- doc/introduction.rst | 3 ++- doc/io.rst | 3 ++- doc/libraries.rst | 3 ++- doc/toolchains.rst | 3 ++- 11 files changed, 22 insertions(+), 11 deletions(-) diff --git a/doc/algorithms.rst b/doc/algorithms.rst index 1268fb76..c15e884a 100644 --- a/doc/algorithms.rst +++ b/doc/algorithms.rst @@ -23,8 +23,9 @@ .. _beat-core-algorithms: +=========== Algorithms -========== +=========== Algorithms are user-defined piece of software that run within the blocks of a toolchain. An algorithm can read data on the input(s) of the block and write diff --git a/doc/api.rst b/doc/api.rst index eb5654c4..7944bba5 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -21,8 +21,9 @@ .. with the BEAT platform. If not, see http:..www.gnu.org.licenses.. .. +==== API -=== +==== This section includes information for using the Python API of ``beat.core``. diff --git a/doc/backend_api.rst b/doc/backend_api.rst index b7879d10..88ea148b 100644 --- a/doc/backend_api.rst +++ b/doc/backend_api.rst @@ -22,8 +22,9 @@ .. _beat-core-backend-api: +============ Backend API -=========== +============ As it is currently setup, user code at toolchain blocks running on the platform consumes data stored on disk and produces data which is stored on disk so that diff --git a/doc/databases.rst b/doc/databases.rst index 61183647..749974bc 100644 --- a/doc/databases.rst +++ b/doc/databases.rst @@ -21,8 +21,9 @@ .. with the BEAT platform. If not, see http://www.gnu.org/licenses/. .. +========== Databases -========= +========== A database is a collection of data files, one for each output of the database. This data are inputs to the BEAT toolchains. Therefore, it is important to diff --git a/doc/dataformats.rst b/doc/dataformats.rst index 25ddc63e..e97b636f 100644 --- a/doc/dataformats.rst +++ b/doc/dataformats.rst @@ -23,8 +23,9 @@ .. _beat-core-dataformats: +============= Data formats -============ +============= Data formats formalize the interaction between algorithms and data sets, so they can communicate data in an orderly manner. All data formats produced or diff --git a/doc/develop.rst b/doc/develop.rst index e6188020..6a8092f2 100644 --- a/doc/develop.rst +++ b/doc/develop.rst @@ -137,8 +137,9 @@ sphinx:: Other bits ---------- +========== Profiling -========= +========== In order to profile the test code, try the following:: diff --git a/doc/experiments.rst b/doc/experiments.rst index 61c8ee0d..d392eda2 100644 --- a/doc/experiments.rst +++ b/doc/experiments.rst @@ -23,8 +23,9 @@ .. _beat-core-experiments: +============ Experiments -=========== +============ An experiment is the reunion of algorithms, datasets, a toolchain and parameters that allow the platform to schedule and run the prescribed recipe diff --git a/doc/introduction.rst b/doc/introduction.rst index f9bfcc55..bdf95746 100644 --- a/doc/introduction.rst +++ b/doc/introduction.rst @@ -23,8 +23,9 @@ .. _beat-core-introduction: +============= Introduction -============ +============= The BEAT platform is a web-based system for certifying results for software-based data-driven workflows that can be sub-divided functionally (into diff --git a/doc/io.rst b/doc/io.rst index 8fe05ead..488f542f 100644 --- a/doc/io.rst +++ b/doc/io.rst @@ -23,8 +23,9 @@ .. _developerguide-io: +=============== Inputs/Outputs -============== +=============== .. _developerguide-io-introduction: diff --git a/doc/libraries.rst b/doc/libraries.rst index 4e6c1f87..3bd225f3 100644 --- a/doc/libraries.rst +++ b/doc/libraries.rst @@ -23,8 +23,9 @@ .. _beat-core-libraries: +========== Libraries -========= +========== Algorithms are fundamental elements in the platform that formally describe how to process data. In particular, they are always attached to a specific diff --git a/doc/toolchains.rst b/doc/toolchains.rst index faac7938..08586892 100644 --- a/doc/toolchains.rst +++ b/doc/toolchains.rst @@ -23,8 +23,9 @@ .. _beat-core-toolchains: +=========== Toolchains -========== +=========== A toolchain describes the workflow of a particular experiment. Its declaration defines: -- GitLab