Yaml reader for sphinx - based on MyST?

[arwedus]

Hi @chrisjsewell,

I was looking for a YAML reader that parses yaml into Sphinx directives, e.g. directly from yaml files. As MyST already supports a little bit of yaml syntax, I was wondering if you just use parts of a larger yaml parser and could do more, or if you're just supporting that particular bit of yaml syntax?

What I'm talking about is the directives option, like:

```{directive} title
---
option1: value
option2: value
---
Content
```

[chrisjsewell]

Heya, I'm not quite sure what you after? As in reading directives options from a YAML file, like

my_options.yaml:

option1: value
option2: value

```{directive} title
options: my_options.yaml

Content
```

[arwedus]

Actually, I'm looking to parse simple yaml files as input to Sphinx, e.g.

--- # data.yaml
- directive1
  title: The title
  option1: this
  option2: that
  content: |
    here I can put random RestructuredText but no `directives <https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#directives>`_

- note
  title: this is a standard rST directive
  content: |
    I'm **bold**.

This would probably be another extension. I just wanted to know if the basis of this is already available in MyST and could be easily re-used.

[chrisjsewell]

eurgh, In principle yeh, this is basically what happens in https://github.com/executablebooks/MyST-Parser/blob/7654462dc8521c0090478efa4dcfba6227e97a84/myst_parser/docutils_renderer.py#L1252

there would be some work to "isolate" this code though