Skip to content

Watch for changes to the template file during documentation serve#9244

Merged
zanieb merged 1 commit intomainfrom
zb/watch
Nov 20, 2024
Merged

Watch for changes to the template file during documentation serve#9244
zanieb merged 1 commit intomainfrom
zb/watch

Conversation

@zanieb
Copy link
Copy Markdown
Member

@zanieb zanieb commented Nov 19, 2024

Fixes this really annoying behavior where the served documentation would not reflect changes to the mkdocs template file (where we store all of our actual configuration)

ref mkdocs/mkdocs#2642

@zanieb zanieb added the documentation Improvements or additions to documentation label Nov 19, 2024
@zanieb zanieb marked this pull request as ready for review November 20, 2024 04:31
Copy link
Copy Markdown
Member

@dhruvmanila dhruvmanila left a comment

Choose a reason for hiding this comment

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

This is great, I'll adopt this for Ruff as well.

@zanieb zanieb merged commit dab55dd into main Nov 20, 2024
@zanieb zanieb deleted the zb/watch branch November 20, 2024 04:39
dhruvmanila added a commit to astral-sh/ruff that referenced this pull request Nov 20, 2024
…14476)

## Summary

Similar to astral-sh/uv#9244, but we need to use
the `mkdocs.generated.yml` file because the `scripts/generate_mkdocs.py`
uses the `mkdocs.template.yml` to generate the final config.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants