Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add version into generated files #205

Merged
merged 6 commits into from
Sep 5, 2023

Conversation

felixfontein
Copy link
Collaborator

@felixfontein felixfontein commented Aug 30, 2023

The generated HTML by Sphinx contains something like <meta content="2.3.1.post0" name="antsibull-docs">.

@samccann
Copy link
Contributor

samccann commented Sep 5, 2023

Because a year from now, I'll never remember the reason for this change:
the idea is that you can easily check when looking at HTML which version of antsibull-docs was used - this can be helpful when figuring out whether some dependency update really worked, or whether some broken layout might be related to a certain antsibull-docs version

@felixfontein felixfontein marked this pull request as ready for review September 5, 2023 15:26
@felixfontein
Copy link
Collaborator Author

This was discussed at today's DaWGs meeting, we agreed that the version should always be inserted for now. If someone comes up with a good reason why it should be possible to disable it, we can weight that reason against the additional complexity a switch needs.

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.

3 participants