Skip to content

Commit 2a5b973

Browse files
PierreRaybautPierreRaybaut
committed
Doc: added meta descriptions and keywords
1 parent 4f3539f commit 2a5b973

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+1198
-723
lines changed

‎doc/contributing/index.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
Contributing
22
============
33

4+
.. meta::
5+
:description: Contribute to DataLab project, the open-source scientific data analysis platform
6+
:keywords: DataLab, contribute, open-source, scientific, data, analysis, platform, signal processing, image processing
7+
48
DataLab is **your** platform. If you want it to be improved, you **can** contribute to
59
the project, whether you are a developer or not.
610

‎doc/features/general/command.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Command line features
44
=====================
55

6+
.. meta::
7+
:description: DataLab command line features
8+
:keywords: command line, cdl, datalab, run, test, demo
9+
610
Run DataLab
711
-----------
812

‎doc/features/general/instviewer.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Installation and configuration viewer
44
=====================================
55

6+
.. meta::
7+
:description: DataLab's installation and configuration viewer
8+
:keywords: installation, configuration, viewer, DataLab
9+
610
Because of the multiple ways of installing DataLab on your machine,
711
understanding why the application behaves unexpectedly without any
812
information on your configuration could be very challenging.

‎doc/features/general/logviewer.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Log viewer
44
==========
55

6+
.. meta::
7+
:description: DataLab's log viewer
8+
:keywords: DataLab, log, viewer, crash, bug, report
9+
610
Despite countless efforts (unit testing, test coverage, ...),
711
DataLab might crash or behave unexpectedly.
812

‎doc/features/general/macros.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Macros
44
======
55

6+
.. meta::
7+
:description: How to use macros in DataLab, the open-source data analysis and visualization platform
8+
:keywords: DataLab, data analysis, data visualization, open-source, Python, macros
9+
610
Overview
711
--------
812

‎doc/features/general/model.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Internal data model
44
===================
55

6+
.. meta::
7+
:description: Internal model of DataLab, the open-source scientific data analysis and visualisation platform
8+
:keywords: DataLab, internal model, data model, signal, image, dataset, parameter, computation, scientific data analysis, visualisation, platform
9+
610
In its internal data model, DataLab stores data using two main classes:
711

812
* :class:`cdl.obj.SignalObj`, which represents a signal object, and

‎doc/features/general/plugins.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Plugins
44
=======
55

6+
.. meta::
7+
:description: Plugin system for DataLab, the open-source scientific data analysis and visualization platform
8+
:keywords: DataLab, plugin, processing, input/output, HDF5, file format, data analysis, visualization, scientific, open-source, platform
9+
610
DataLab is a modular application. It is possible to add new features to DataLab
711
by writing plugins. A plugin is a Python module that is loaded at startup by
812
DataLab. A plugin may add new features to DataLab, or modify existing features.

‎doc/features/general/remote.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Remote controlling
44
==================
55

6+
.. meta::
7+
:description: How to remote control DataLab, the open-source scientific data analysis and visualization platform
8+
:keywords: DataLab, remote control, XML-RPC, Python, IDE, Spyder, Jupyter, third-party application, signal, image, HDF5, calculation, processor
9+
610
DataLab may be controlled remotely using the `XML-RPC`_ protocol which is
711
natively supported by Python (and many other languages). Remote controlling
812
allows to access DataLab main features from a separate process.

‎doc/features/general/workspace.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Workspace
44
=========
55

6+
.. meta::
7+
:description: Workspace and HDF5 Browser in DataLab, the open-source scientific data analysis and visualization platform
8+
:keywords: DataLab, workspace, HDF5, browser, scientific, data, analysis, visualization, platform
9+
610
Basic concepts
711
--------------
812

‎doc/features/index.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
Features
22
========
33

4+
.. meta::
5+
:description: DataLab features
6+
:keywords: DataLab, features, signal processing, image processing
7+
48
DataLab features are detailed in the following sections. The first section
59
describes the general features of DataLab, then the two following sections
610
describe the features specific to the signal and image processing panels.

0 commit comments

Comments
 (0)