Chris Sewell

Results 1356 comments of Chris Sewell

Thanks @Carreau, I'll bear that in mind 😄 While you're here; I just added https://myst-parser.readthedocs.io/en/latest/using/syntax-optional.html#auto-generated-header-anchors, so that you can write e.g. `[](path/to/doc.md#heading-anchor)` and it will work correctly both directly on...

If anyone is motivated to tackle this, I would say an initial step would be to implement a https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#field-lists plugin within https://github.com/executablebooks/mdit-py-plugins. Using this, we could implement the classic doctring...

UPDATE: With #455 implemented, it is now fully possible to use sphinx's [python-domain directives](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#python-domain) in MyST 🎉 (see https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#field-lists). For example, this will be properly parsed: ```` ```{py:function} send_message(sender, priority)...

Thanks for the feedback @john-hen Note, another approach would be to override `AutodocDirective`, and add a line here: https://github.com/sphinx-doc/sphinx/blob/edd14783f3cc6222066fd63efbe28c2728617e18/sphinx/ext/autodoc/directive.py#L172, which uses https://github.com/executablebooks/rst-to-myst to converts the RST in `params.result` to MyST...

Heya @jborean93, https://github.com/executablebooks/MyST-Parser/issues/228#issuecomment-1041097220 is unrelated to the parsing of docstrings as Markdown, and should be opened as a separate issue. I seem to recall there being a similar issue already...

- See: https://github.com/executablebooks/MyST-Parser/pull/613, thoughts welcome

> These use brackets for the target: `[title][target]`, where target is looked up elsewhere. Just to note @john-hen this is not particularly easy, because any standard CommonMark parser will only...

@john-hen I'm afraid that if you don't agree with commonmark specification, then you need to petition for that to change, it is not the business of MyST to go against...

Thanks for the offer @webknjaz! I would certainly be interested to see how it works. I would note though, my opinion on the changelog is that, at least the initial...

It would also be idea to offer it as a template like construct, similar to https://nbsphinx.readthedocs.io/en/0.3.0/prolog-and-epilog.html, such that one could adjust the behaviour based on variables like the docname