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

[docs] build with Documenter#master (v0.28-DEV) #3094

Merged
merged 4 commits into from
Nov 17, 2022
Merged

[docs] build with Documenter#master (v0.28-DEV) #3094

merged 4 commits into from
Nov 17, 2022

Conversation

@codecov
Copy link

codecov bot commented Sep 28, 2022

Codecov Report

Base: 97.68% // Head: 97.68% // No change to project coverage 👍

Coverage data is based on head (1634f8d) compared to base (2b7bdfc).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3094   +/-   ##
=======================================
  Coverage   97.68%   97.68%           
=======================================
  Files          33       33           
  Lines        4442     4442           
=======================================
  Hits         4339     4339           
  Misses        103      103           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@odow
Copy link
Member Author

odow commented Sep 28, 2022

Things are a lot better (compare against https://jump.dev/JuMP.jl/dev/JuMP.pdf).

Here are some thoughts of things we could still change:

We're missing the logo

image

The warning color looks gold, rather than yellow

image

is not the same as

image

I don't really like the font

Particularly these bullets

image

and you can't tell \texttt text

image

@odow
Copy link
Member Author

odow commented Sep 28, 2022

Success! We can see the full table. cc @mortenpi

image

Here's a failure though:

image

GroupBy produces text with {tabular} inside them.

@odow
Copy link
Member Author

odow commented Sep 29, 2022

@mortenpi muuuch better

image

image

image

@odow
Copy link
Member Author

odow commented Nov 17, 2022

Closing. This can wait for the documenter release.

@odow odow closed this Nov 17, 2022
@odow odow deleted the od/doc-28 branch November 17, 2022 01:54
@mortenpi
Copy link
Contributor

I would suggest using #master -- I don't have a clear ETA on the release right now.

@odow
Copy link
Member Author

odow commented Nov 17, 2022

I would suggest using #master

Are more breaking changes expected? I guess the two breaking changes are pretty minor: https://github.com/JuliaDocs/Documenter.jl/blob/master/CHANGELOG.md#version-v0280-unreleased

@odow odow restored the od/doc-28 branch November 17, 2022 20:06
@odow odow reopened this Nov 17, 2022
@odow odow changed the title WIP: [docs] build with Documenter@0.28 [docs] build with Documenter#master (v0.28-DEV) Nov 17, 2022
@mortenpi
Copy link
Contributor

I would like to get this one fixed, but it may lead to some slightly breaking behavior. Just been a little short on time right now.

@odow
Copy link
Member Author

odow commented Nov 17, 2022

The two main arguments for switching are:

  1. lots of improvements to the PDF
  2. a link to GitHub from the header of each page!

These two changes are quite nice, and I try to stay abreast of the changes in Documenter, so I think I'm willing to live dangerously until the next release.

@mortenpi
Copy link
Contributor

I would suggest committing a docs/Manifest.toml here though, to fix yourself to a commit. That would take some of the adrenaline out of your life.

docs/make.jl Outdated Show resolved Hide resolved
@odow
Copy link
Member Author

odow commented Nov 17, 2022

Perhaps I'll just use a specific commit for now.

@odow odow merged commit e9692eb into master Nov 17, 2022
@odow odow deleted the od/doc-28 branch November 17, 2022 23:12
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.

2 participants