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

Retrocatively generate warning for outdated docs #51

Merged
merged 13 commits into from
Jun 6, 2021

Conversation

pfitzseb
Copy link
Member

Companion to JuliaDocs/Documenter.jl#1577.

This uses the default light theme and a bunch of inline elements to make sure it works with whatever theme the old docs might've been using (e.g. mkdocs).

@mortenpi
Copy link
Member

mortenpi commented May 27, 2021

This is awesome!

  1. I did notice that somehow the x is not visible with the old Documenter HTML theme:

    Screenshot from 2021-05-27 20-17-13

    Probably some weird interaction with the CSS there. For the new theme and MkDocs it seems to work perfectly.

  2. It skips the latest version? I guess the idea is that you'd fix that on master? But I think you might end up missing a fix for a version (e.g. 0.5.1 is the current latest, where it doesn't get applied, but the next tag is 0.6.0, which will be the first one that has it from Documenter). Could we just detect if the tag is there or not already?

  3. Do you think it would be feasible to have a small test for this code as well, e.g. to update a simple sample HTML file and see if it matches a reference output? Just to test that the code actually runs.

src/OutdatedWarning.jl Outdated Show resolved Hide resolved
@pfitzseb
Copy link
Member Author

I can't repro the styling issue:
image

The other comments should be addressed, but Windows CI chokes on the symlink. Will figure out what's going on with that...

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.

LGTM! The styling issue seems to be gone now too (even when building with the old commit), so I am not sure what was causing that.

Edit: Oh, I can repro the styling issue with the d00cf10 commit. So I think you already managed to fix the problem between me checking out this branch and posting the feedback 😛

@mortenpi mortenpi merged commit 49535a2 into master Jun 6, 2021
@mortenpi mortenpi deleted the sp/outdated-warning branch June 6, 2021 00:21
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.

2 participants