Keep mkdocs.yml formatting about mike HOT 4 CLOSED

v0.5.2 is out on PyPI now with the quoting fix.

from mike.

Unfortunately, no, it's not really possible (well, not without a lot of work). I think it's possible to preserve the quotes, but the other bits would require a lot of hacks that probably wouldn't work in all cases.

What makes this so hard is that the parser (ruamel.yaml) takes the blank line at the end of your extra_css list and turns it into a "comment" node that sits after the last item in the list, rather than after the extra_css key. That makes it really hard on my end to tell when we have a situation like this. I'd need to handle cases like: 1) post-item comments that have contents other than a newline (i.e. real comments), 2) double-spacing of lines between each item, 3) how to apply spacing rules to other lists (e.g. if you have extra_css already but not extra_javascript).

This is partly a limitation of the parser I'm using (which does a better, but still imperfect, job of round-tripping YAML) and partly a result of YAML probably being too complex for its own good. Given that this is a command that people will generally only run once, it's tough to justify spending weeks improving the parsing so that it Just Works.

from mike.

Of course, I understand 🙂 Closing then, thank you for answering so quickly!

from mike.

Ok, I fixed the quoting issue in 2a5a12c. Now I just need to think about whether it's worth releasing a new version with only that fix, or if I should wait and see if there are any other new things to add to mike before publishing an update...

from mike.