.. Ferronier-gitlab documentation master file, created by
   sphinx-quickstart on Thu Apr 16 21:32:25 2026.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

==============
Ferronier-yaml
==============

A `Ferronier <https://ferronier.forge.apps.education.fr/>`__ plugin to parse `YAML <https://yaml.org>`__ data.

.. contents::
   :depth: 1
   :local:

Download and Install
====================

``ferronier-yaml`` is published `on Pypi <https://pypi.org/project/ferronier-yaml/>`__::

    python3 -m pip install ferronier-yaml

Source code is hosted on the `Forge des communs numériques éducatifs <https://forge.apps.education.fr/ferronier/plugins/ferronier-yaml>`__.

Load plugin
===========

This plugin is loaded by adding the (empty) section ``[plugins.yaml]`` in your `configuration file <https://ferronier.forge.apps.education.fr/doc/configuration/>`__:

.. code-block:: toml

   data = "foobar.yaml"

   [plugins.yaml]

Use plugin
==========

This plugin has no options. If your data file or url ends with ``.yaml``, it is parsed as YAML data:

.. code-block:: toml

   data = "foobar.yaml"

   [plugins.yaml]

Disregarding file or URL extension, you can also explicitely set YAML as the file format:

.. code-block:: toml

   [data]
   source = "remote"
   path = "https://example.com/data.txt"
   format = "yaml"
