Refactor Markdown Extension Options Config. #528
Conversation
|
This looks great! I should be able to review it today. |
|
|
||
| def run_validation(self, value): | ||
| if isinstance(value, dict): | ||
| # Delete this if block when dict support is removed |
There was a problem hiding this comment.
I've been trying to add # TODO: remove in 1.0 to these. It could happen sooner, potentially, but 1.0 would be the latest this should happen.
|
This is lovely, do you plan to do any more updates? I'm happy to merge as it is. Tested it and it works great. |
|
The only other thing I would consider doing at this point is removing the OrderedDict stuff for the config as this removes the need for it. I don't think it would hurt to leave it in, but removing it removes one more thing to maintain long-term. @facelessuser have any thoughts? Regardless, that could happen latter. Feel free to merge any time. |
|
Remove it, unless ordered dicts will be desired somewhere in the future. It hurts nothing, but I only added it because, at the time, it was decided not to do the extension config this way. But now we are, so the original need is gone. |
Config validation now handles all extension processing: * Builtin extensions are defined and within the default scheme. * User extensions are defined only as a list in the config. Note, this is a backward incompatable change from the previous (short-lived) release. * The users extensions are added to the list of builtins. * Any duplicates are accounted for in validation. * Extension options are supported by a child key/value pair on the ext name. * All extension options are compiled into a format Markdown accepts within the validation process and are saved to the internal `mdx_configs` config setting. * The `mdx_configs` setting is private and raises an error if set by the user. * A whole suite of tests were added to test all aspects of ext validation. All relevant build tests were updated to pass the config to `build.convert_markdown` as the config now handles all extension data. The relevant documentation was updated to reflect the changes. While I was at it, I spellchecked the entire document and made a few additional formatting changes. This fixes mkdocs#519 plus a lot more.
|
On further thought, the OrderedDict stuff should be removed with the support for a dict for markdown_extensions. I'm suggesting we leave it in for now. I just pushed an update with TODOs at the relevant parts of the code (also swashed a few commits for a cleaner history). I'm done with this. Feel free to merge anytime. |
Good point, I checked that you were preserving the new list order with |
With the markdown_extensions refactor, all extensions are defined in a list which retains order. No need for an Ordered Dict. As the OrderedDict stuff was never released, no deprecation path is nessecary.
Ok, I was thinking a release had happened, but you are right it didn't. I just ripped it out. I really am done now. |
|
Thanks! Just waiting for CI and then I'll merge. |
Refactor Markdown Extension Options Config.
Config validation now handles all extension processing:
a backward incompatable change from the previous (short-lived) release.
within the validation process and are saved to the internal
mdx_configsconfig setting.
mdx_configssetting is private and raises an error if set by the user.All relevant build tests were updated to pass the config to
build.convert_markdownas the config now handles all extension data.The relevant documentation was updated to reflect the changes. While I was
at it, I spellchecked the entire document and made a few additional formatting
changes.
This fixes #519 plus a lot more.