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

Apply the OutdatedWarning from DocumenterTools #2631

Merged
merged 1 commit into from
Jun 20, 2021
Merged

Conversation

odow
Copy link
Member

@odow odow commented Jun 19, 2021

I'm hoping that the preview link should work. Preview doesn't work because it's not on master. Because this is a bit of a mess at the moment.

I followed: https://discourse.julialang.org/t/ann-documenter-0-27/62726

@mortenpi is it meant to re-write such a large chunk of existing docs? I thought it just added the banner?

Here is what I see locally:

image

@mortenpi
Copy link
Contributor

I think it's because it uses an XML parser to read-modify-write the HTML and this leads to some formatting changes. It think it's all good if it all seems to work locally, but maybe @pfitzseb could also take a quick look.

@odow
Copy link
Member Author

odow commented Jun 19, 2021

Yeah I had a look around locally and everything seemed okay. It'd be hard to spot any mistakes though.

@odow odow mentioned this pull request Jun 19, 2021
@odow
Copy link
Member Author

odow commented Jun 20, 2021

I'll merge for now. We can take a look once it's merged and revert this or make any necessary changes.

@odow odow merged commit 6a96210 into gh-pages Jun 20, 2021
@odow odow deleted the od/documenter-warning branch June 20, 2021 23:03
@pfitzseb
Copy link

Yeah, getting proper diffs is hard/impossible. The good news is that we're using Gumbo.jl for parsing/writing, which should be guaranteed not to break anything.

@odow
Copy link
Member Author

odow commented Jun 21, 2021

I did break this #2633.

I guess because the most recent stable wasn't built with Documenter 0.27?

@pfitzseb
Copy link

Kind of. You wouldn't get the warning if stable had been build with 0.27, yes.
But when using OutdatedWarning.generate you need to figure out which changes to check in yourself -- that warning is completely unconditional.

@odow
Copy link
Member Author

odow commented Jun 21, 2021

you need to figure out which changes to check in yourself

Yeah I missed this the first time around. (Although it was kinda obvious in retrospect.)

@pfitzseb
Copy link

Added a warning to the docs: JuliaDocs/DocumenterTools.jl#55

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

Successfully merging this pull request may close these issues.

3 participants