Skip to content

Conversation

@matt-graham
Copy link
Collaborator

@matt-graham matt-graham commented Feb 10, 2025

Resolves #515

  • Updates mkdocs.yml configuration in template to use structure required by current MkDocs.
  • Fixes TOML tox configuration for docs environment 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 docs as well as mkdocs build to also catch error in tox configuration. I am not sure whether we would want to add tox as a development dependency here, or create a temporary virtual environment as suggested also in #516, install tox there and test running tox -e docs (plus potentially default test environment)?

@matt-graham
Copy link
Collaborator Author

If we do go with including pytest-venv as a test dependency in #519 then that would be an easy way to also test running mkdocs build by installing mkdocs and tox in a temporary venv.

@matt-graham matt-graham marked this pull request as ready for review February 19, 2025 14:56
@matt-graham matt-graham requested a review from a team February 19, 2025 14:58
Copy link
Member

@paddyroddy paddyroddy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

@matt-graham matt-graham merged commit e3ba5e5 into main Feb 19, 2025
13 checks passed
@matt-graham matt-graham deleted the mmg/mkdocs-build-fixes branch February 19, 2025 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

MkDocs build from template broken

3 participants