search

executablebooks / MyST-Parser

An extended commonmark compliant parser, with bridges to docutils/sphinx
https://myst-parser.readthedocs.io
MIT License
751 stars 197 forks source link

configuration via `pyproject` #827

Closed pascal456 closed 11 months ago

pascal456 commented 11 months ago

Describe the feature you'd like to request

Configuration via pyproject.toml

For research projects we use Python most of the times. Currently we are setting up documentation and also experiment presentation with notebooks. To be precise, we agreed on a configure as little as much approach. And myst Markdown and parser and notebooks solve this very nicely.

It would be nice if we could do the configuration of Myst in the file that we use anyway. Pyproject has long since become the standard for many Python projects, so we prefer this over myst.yml. So configuration would be done in pyproject.toml instead.

Is this a thing that is valuable to discuss? Is it maybe already implemented, because we could imagine it is not, thinking of the importance of the toml format to python in the format.

Describe the solution you'd like

No response

Describe alternatives you've considered

No response

welcome[bot] commented 11 months ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:

chrisjsewell commented 11 months ago

Heya, I would link to https://github.com/sphinx-doc/sphinx/issues/9040, as ideally this would be something that could be done at the "sphinx level"

pascal456 commented 11 months ago

thanks for the quick answer @chrisjsewell ! So I just started to look into myst and I was not aware of that. Do I understand correctly that under the hood, it is the Sphinx package what is used to build the the documents (websites in my case)?