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

“When was the documentation last updated?” #724

Closed
cormullion opened this issue May 13, 2018 · 6 comments · Fixed by #1043
Closed

“When was the documentation last updated?” #724

cormullion opened this issue May 13, 2018 · 6 comments · Fixed by #1043

Comments

@cormullion
Copy link
Contributor

cormullion commented May 13, 2018

If I want to know when a documentation set was built, where should do I look? Say, is there anywhere where a string says “docs generated 2016-12-34” or something? “Stable” is OK, but is there anything in more detail?

(In earlier times, they used to include a colophon.)

There is a sneaky way of finding out, I just remembered. But it isn’t obvious...

@mortenpi
Copy link
Member

The HTML backend has never had a colophon, but this is a feature that would be nice to have, I think. At the moment, the best option would be to check the gh-pages branch of the repository. It tracks all the changes and the commit message says which commit was used to build the particular doc. E.g.: https://github.com/JuliaDocs/Documenter.jl/tree/gh-pages

X-ref: #212

@cormullion
Copy link
Contributor Author

cormullion commented May 13, 2018

I’m thinking for end users that’s not ideal... :) I do one for Luxor (http://juliagraphics.github.io/Luxor.jl/latest/) for my own benefit, but it might be good to be consistent!

@fredrikekre
Copy link
Member

Perhaps we can add a footnote, similar to your manually added text, at the index page. Nice way to sneak in some advertisement for Documenter too :)

@cormullion
Copy link
Contributor Author

I’d say go for it; there’s going to be a lot more documentation action in the next few months... :)

@mortenpi
Copy link
Member

In the HTMLWriter we could do a proper footer as well. Also, in HTML you have the <meta> tags too. It would be good to have a list of what information should be displayed there. Julia, Documenter versions, commit/tag of the package, build time?

@cormullion
Copy link
Contributor Author

Also which platform the documentation was generated on? For example I noticed that certain fonts were unavailable when I build on, say, Linux rather than MacOS. Could be useful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants