Skip to content

docs
docs
Commit f047c4a8 authored by Samuel GAIST's avatar Samuel GAIST
Browse files
Options

Merge branch 'reorganize' into 'master' 

Reorganize docs for improved flow and navigation

Closes #14

See merge request !14
parents 84cb92a6 f938cfe9
Pipeline #40199 passed with stages
      in 5 minutes and 47 seconds
      Hide whitespace changes
      Inline Side-by-side
      Showing with 112 additions and 70 deletions
      .gitignore
      View file @ f047c4a8
      ......@@ -5,12 +5,7 @@
      bin/
      bob.docs.egg-info/
      develop-eggs/
      doc/beat.core/
      doc/beat.cmdline/
      doc/beat.backend.python/
      doc/beat.editor/
      doc/beat.web/
      doc/gridtk
      doc/beat
      doc/extra-intersphinx.txt
      doc/nitpick-exceptions.txt
      eggs/
      ......
      doc/intro/algorithms.rst → doc/algorithms.rst
      View file @ f047c4a8
      ......@@ -407,7 +407,7 @@ the appropriate amount of data and process it.
      .. _beat-system-algorithms-examples-simple-processor:
      Simple autonomous processor algorithm (no parametrization)
      ................................................
      ..........................................................
      At the very minimum, a processor algorithm class must look like this:
      ......@@ -442,7 +442,7 @@ The platform will call this method once per block of data available on the
      .. _beat-system-algorithms-examples-simple-evaluator:
      Simple autonomous evaluator algorithm (no parametrization)
      ................................................
      ..........................................................
      At the very minimum, a processor algorithm class must look like this:
      ......@@ -823,7 +823,7 @@ unsynchronized input (``in3``).
      view = loader.view('in3', i)
      data, _, _ = view[0]
      self.models.append(data['in3'].value)
      return True
      def process(self, inputs, data_loaders, outputs):
      ......
      doc/components.rst 0 → 100644
      View file @ f047c4a8
      .. vim: set fileencoding=utf-8 :
      .. Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/ ..
      .. Contact: beat.support@idiap.ch ..
      .. ..
      .. This file is part of the beat.docs module of the BEAT platform. ..
      .. ..
      .. Commercial License Usage ..
      .. Licensees holding valid commercial BEAT licenses may use this file in ..
      .. accordance with the terms contained in a written agreement between you ..
      .. and Idiap. For further information contact tto@idiap.ch ..
      .. ..
      .. Alternatively, this file may be used under the terms of the GNU Affero ..
      .. Public License version 3 as published by the Free Software and appearing ..
      .. in the file LICENSE.AGPL included in the packaging of this file. ..
      .. The BEAT platform is distributed in the hope that it will be useful, but ..
      .. WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY ..
      .. or FITNESS FOR A PARTICULAR PURPOSE. ..
      .. ..
      .. You should have received a copy of the GNU Affero Public License along ..
      .. with the BEAT platform. If not, see http://www.gnu.org/licenses/. ..
      .. _beat-components:
      ===============
      BEAT Components
      ===============
      This guide details each of BEAT building blocks, their relationships and how
      to use the command-line interface to interact with the BEAT platform
      efficiently.
      .. toctree::
      dataformats
      algorithms
      libraries
      databases
      toolchains
      experiments
      plotters
      plotterparameters
      .. include:: links.rst
      doc/index.rst
      View file @ f047c4a8
      .. vim: set fileencoding=utf-8 :
      .. Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/ ..
      .. Contact: beat.support@idiap.ch ..
      .. ..
      .. This file is part of the beat.docs module of the BEAT platform. ..
      .. ..
      .. Commercial License Usage ..
      .. Licensees holding valid commercial BEAT licenses may use this file in ..
      .. accordance with the terms contained in a written agreement between you ..
      .. and Idiap. For further information contact tto@idiap.ch ..
      .. ..
      .. Alternatively, this file may be used under the terms of the GNU Affero ..
      .. Public License version 3 as published by the Free Software and appearing ..
      .. in the file LICENSE.AGPL included in the packaging of this file. ..
      .. The BEAT platform is distributed in the hope that it will be useful, but ..
      .. WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY ..
      .. or FITNESS FOR A PARTICULAR PURPOSE. ..
      .. ..
      .. You should have received a copy of the GNU Affero Public License along ..
      .. with the BEAT platform. If not, see http://www.gnu.org/licenses/. ..
      .. _beat_general:
      ======
      BEAT
      ======
      ......@@ -21,10 +44,17 @@ both aspects transparently. Data privacy is guaranteed inside the platform.
      Start here
      ==========
      * :ref:`beat_general`
      Documentation of all BEAT packages
      ==================================
      .. toctree::
      :maxdepth: 2
      install
      introduction
      components
      user
      BEAT software packages
      ======================
      * :ref:`beat_core`
      ......@@ -33,14 +63,13 @@ Documentation of all BEAT packages
      * :ref:`beat_editor`
      * :ref:`beat_web`
      Index of all Packages
      =====================
      Index of Packages
      =================
      .. toctree::
      :maxdepth: 1
      :titlesonly:
      beat <intro/index.rst>
      beat.core <beat/beat.core/doc/index.rst>
      beat.cmdline <beat/beat.cmdline/doc/index.rst>
      beat.backend.python <beat/beat.backend.python/doc/index.rst>
      ......
      doc/intro/index.rst
      View file @ f047c4a8
      ......@@ -21,7 +21,6 @@
      .. with the BEAT platform. If not, see http://www.gnu.org/licenses/. ..
      .. _beat_general:
      ======
      BEAT
      ......@@ -32,11 +31,6 @@ components of the BEAT framework and a brief tutorial that examplifies how to
      build and execute a complete experiment locally.
      .. toctree::
      install
      introduction
      user
      Indices and tables
      ==================
      ......
      doc/intro/links.rst deleted 100644 → 0
      View file @ 84cb92a6
      .. Place your links here
      .. _beat: https://www.idiap.ch/software/beat
      .. _docker: https://www.docker.com/
      .. _reproducible research: https://reproducibleresearch.net/
      .. _numpy safe-casting rules: http://docs.scipy.org/doc/numpy/reference/generated/numpy.can_cast.html
      .. _zen of python: https://www.python.org/dev/peps/pep-0020/
      .. _json: http://en.wikipedia.org/wiki/JSON
      .. _beat.env.python27: http://gitlab.idiap.ch/biometric/beat.env.python27
      .. _beat.backend.python: http://gitlab.idiap.ch/biometric/beat.backend.python
      .. _python 2.7: http://www.python.org
      .. _zero message queue: http://zeromq.org
      .. _zmq: http://zeromq.org
      .. _language bindings: http://zeromq.org/bindings:_start
      .. _python bindings: http://zeromq.org/bindings:python
      .. _markdown: http://daringfireball.net/projects/markdown/
      .. _restructuredtext: http://docutils.sourceforge.net/rst.html
      .. _conda: https://conda.io/
      .. _beat editor: https://www.idiap.ch/software/beat/docs/beat/docs/new/beat.editor/doc/index.html
      .. _bob: https://www.idiap.ch/software/bob/docs/bob/docs/stable/bob/doc/index.html
      .. _idiap: http://www.idiap.ch
      .. _eigenface: https://en.wikipedia.org/wiki/Eigenface
      .. _database interfaces: https://www.idiap.ch/software/bob/docs/bob/docs/stable/bob/bob.db.base/doc/index.html
      doc/intro/introduction.rst → doc/introduction.rst
      View file @ f047c4a8
      ......@@ -23,9 +23,9 @@
      .. _beat-system:
      ===========================
      Getting Started with BEAT
      ===========================
      ==============
      Introduction
      ==============
      The BEAT framework describes experiments through fundamental building blocks
      (object types):
      ......@@ -181,26 +181,4 @@ data formats, algorithms, toolchains and define experiments rather intuitively.
      It also provides a command-line interface which is used in parallel with the GUI
      for running experiments, creating, modifying, or deleting objects and interacting with the BEAT platform.
      BEAT Building Blocks
      ====================
      The rest of this guide details each of BEAT building blocks, their relationships and how to use the command-line
      interface to interact with the BEAT platform efficiently.
      .. toctree::
      dataformats
      algorithms
      libraries
      databases
      toolchains
      experiments
      plotters
      plotterparameters
      .. include:: links.rst
      doc/links.rst
      View file @ f047c4a8
      ......@@ -16,7 +16,8 @@
      .. _markdown: http://daringfireball.net/projects/markdown/
      .. _restructuredtext: http://docutils.sourceforge.net/rst.html
      .. _conda: https://conda.io/
      .. _beat_editor: https://www.idiap.ch/software/beat/docs/beat/docs/new/beat.editor/doc/index.html
      .. _beat editor: https://www.idiap.ch/software/beat/docs/beat/docs/new/beat.editor/doc/index.html
      .. _bob: https://www.idiap.ch/software/bob/docs/bob/docs/stable/bob/doc/index.html
      .. _idiap: http://www.idiap.ch
      .. _eigenface: https://en.wikipedia.org/wiki/Eigenface
      .. _database interfaces: https://www.idiap.ch/software/bob/docs/bob/docs/stable/bob/bob.db.base/doc/index.html
      doc/intro/user.rst → doc/user.rst
      View file @ f047c4a8
      .. vim: set fileencoding=utf-8 :
      .. Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/ ..
      .. Contact: beat.support@idiap.ch ..
      .. ..
      .. This file is part of the beat.docs module of the BEAT platform. ..
      .. ..
      .. Commercial License Usage ..
      .. Licensees holding valid commercial BEAT licenses may use this file in ..
      .. accordance with the terms contained in a written agreement between you ..
      .. and Idiap. For further information contact tto@idiap.ch ..
      .. ..
      .. Alternatively, this file may be used under the terms of the GNU Affero ..
      .. Public License version 3 as published by the Free Software and appearing ..
      .. in the file LICENSE.AGPL included in the packaging of this file. ..
      .. The BEAT platform is distributed in the hope that it will be useful, but ..
      .. WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY ..
      .. or FITNESS FOR A PARTICULAR PURPOSE. ..
      .. ..
      .. You should have received a copy of the GNU Affero Public License along ..
      .. with the BEAT platform. If not, see http://www.gnu.org/licenses/. ..
      .. _tutorial:
      =====================
      ......
      Markdown is supported
      0% or
      You are about to add 0 people to the discussion. Proceed with caution.
      Finish editing this message first!
      Please register or to comment