-
Notifications
You must be signed in to change notification settings - Fork 654
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Make _config.yml
have top-level keys that map onto extensions
#1728
Comments
I think this is an important topic to get correct in order to avoid us having a lot of configuration confusion in the future. I agree with @chrisjsewell's assessment here - it would simplify our configuration considerably if we could have a reliable For example, many Sphinx configurations begin with mystnb:
execution_mode: maps directly on to Then we could also start to remove unnecessarily idiosynchratic configuration differences that we need to hack around with stuff like: I can't tell if this is what @chrisjsewell is suggesting or not so wanted to throw it out there 😅 |
Oh yeh, this is literally how the config is generated, for myst-parser and myst-nb, you just iterate over the config dataclasses and add the prefix: |
I really like the namespaces idea here. This will also really help align options with their software "layer of responsibility". |
_config.yml
have top-level keys that map onto extensions
With new versions of myst-parser and myst-nb, file-level configuration is now available under the
myst
/mystnb` "namespaces":Both of which are auto-generated from a central "source of truth"
This may also be the case with the sphinx-book-theme: executablebooks/sphinx-book-theme#557
It would be desirable for the
_config.yml
to have the same structure, e.g.To address issues like #1673, it might also be desirable to first run the YAML through jinja, with filters added to handle general use cases, e.g. for environmental variables:
cc @choldgraf @mmcky
The text was updated successfully, but these errors were encountered: