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

update to Documenter 0.25 #200

Merged
merged 8 commits into from
Aug 7, 2020
Merged

update to Documenter 0.25 #200

merged 8 commits into from
Aug 7, 2020

Conversation

simeonschaub
Copy link
Member

@simeonschaub simeonschaub commented Aug 4, 2020

This deletes our old hacky workaround for PR previews and replaces it by Documenter's own push_preview version, that was added in 0.24. Hopefully, we should see something at https://www.juliadiff.org/ChainRulesCore.jl/previews/PR200/.
Closes #153

@nickrobinson251
Copy link
Contributor

Thanks!

Unfortunately this seems to break the custom CSS, including the styling of the "terminology" admonitions. It'd at least be good to fix those of possible

@simeonschaub
Copy link
Member Author

Oh right, didn't notice that at first! Seems like Documenter changed some stuff around internally. I will see, what I can do.

@oxinabox
Copy link
Member

oxinabox commented Aug 4, 2020

This will close #153

Like Nick said this breaks the custom CSS.
Which is why i didn't upgrade before.
but now it is possible to use the themes stuff to customise the CSS again so we should be able to make it work

@sethaxen
Copy link
Member

sethaxen commented Aug 4, 2020

Note also that recent versions of Documenter by default use KaTeX to render equations, which renders faster but does not support as much as MathJax. In particular it breaks the array rules tutorial: https://www.juliadiff.org/ChainRulesCore.jl/previews/PR200/arrays.html. There's an argument to switch the backend back to MathJax, or we can update the tutorial to only use KaTeX supported features. I'm inclined to say we do the former for now and then revisit the latter in another PR if we wish.

@simeonschaub
Copy link
Member Author

simeonschaub commented Aug 5, 2020

The dark theme doesn't look quite right with our modifications, so I still need to figure out how to fix this.
@sethaxen JuliaDocs/Documenter.jl#1367 should be merged soon and my goal is to eventually use this with the physics package in ChainRules, so we don't always have to write \frac{\partial f}{\partial x} for every partial derivative. We could also make our differentials look a bit nicer – I personally am a big fan of non-italic d, but it's a bit of a pain to write in bare LaTeX. MathJax3 should also load almost as fast as KaTeX.

@oxinabox
Copy link
Member

oxinabox commented Aug 5, 2020

For anyone else who wants a quick side-by side.
This is the current status.
New is on the left, old is on the right
image

Looking good!

@simeonschaub simeonschaub changed the title use Documenter's built-in push_preview update to Documenter 0.25 Aug 6, 2020
@simeonschaub
Copy link
Member Author

Should be good to go now. I have disabled most of our customizations for the dark theme, except for our methodology blocks. If we really want to customize the dark theme as well, we could always do that at a later time.

@simeonschaub simeonschaub added the documentation Improvements or additions to documentation label Aug 6, 2020
@oxinabox
Copy link
Member

oxinabox commented Aug 6, 2020

Looking at this on my phone.
In Dark Mode
Gorgeous.

Screenshot_20200806-135516.png

@simeonschaub
Copy link
Member Author

simeonschaub commented Aug 6, 2020

Weirdly, the yellow for the Terminology box looks a lot whiter on your screenshot than it does for me. That's probably just a color calibration thing and not our fault though. My browser just displayed the screenshot wrong.

@simeonschaub
Copy link
Member Author

Ok to merge?

@simeonschaub simeonschaub merged commit 5b8720b into master Aug 7, 2020
@simeonschaub simeonschaub deleted the sim/pr_preview branch August 7, 2020 11:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Switch to less evil Documenter 0.24 method for deploying preview docs
4 participants