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

Display Documenter version in document build info. #1609

Merged
merged 1 commit into from
Jun 23, 2021

Conversation

fredrikekre
Copy link
Member

No description provided.

@fredrikekre fredrikekre force-pushed the fe/documenter-version branch from 4084050 to 172dfa3 Compare June 21, 2021 16:58
@fredrikekre
Copy link
Member Author

https://juliadocs.github.io/Documenter.jl/previews/PR1609/ 🎉

@fredrikekre fredrikekre requested a review from mortenpi June 21, 2021 18:21
@mortenpi mortenpi added this to the 0.27.3 milestone Jun 21, 2021
@mortenpi mortenpi added Format: HTML Related to the default HTML output Type: Enhancement labels Jun 21, 2021
Copy link
Member

@mortenpi mortenpi left a comment

Choose a reason for hiding this comment

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

I'm happy with this, but would there also be a way to detect if you're running a modified version of Documenter (e.g. a specific commit from master etc)? Even something that would just detect if it is a tagged version or not would be nice (e.g. outputting v0.27.3 (untagged)).

That said, if you can't think of an easy way to do this, I am more than happy to keep it as is.

@fredrikekre
Copy link
Member Author

That's a bit tricky. A user will generally not have the git repository of Documenter (even if you add by branch/commit) so you would have to try and find some more information in the users manifest which to me doesn't seems worth it.

@fredrikekre fredrikekre merged commit 736d354 into master Jun 23, 2021
@fredrikekre fredrikekre deleted the fe/documenter-version branch June 23, 2021 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Format: HTML Related to the default HTML output Type: Enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants