Fix MkDocs build from template instances #517
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #515
mkdocs.ymlconfiguration in template to use structure required by current MkDocs.toxconfiguration fordocsenvironment to use required array of arrays syntax.Leaving this as a draft for now as we probably want to add a test for building MkDocs site from a template instance to catch things like this in future, ideally by running
tox -e docsas well asmkdocs buildto also catch error intoxconfiguration. I am not sure whether we would want to addtoxas a development dependency here, or create a temporary virtual environment as suggested also in #516, installtoxthere and test runningtox -e docs(plus potentially default test environment)?