search

jump-dev / JuMP.jl

Modeling language for Mathematical Optimization (linear, mixed-integer, conic, semidefinite, nonlinear)
http://jump.dev/JuMP.jl/
Other
2.22k stars 393 forks source link

Bullet point alignment in bibliography #3704

Closed jd-foster closed 6 months ago

jd-foster commented 6 months ago

Something strange is happening with the alignment of the bullets (only visible in dark mode??)

image

Feel free to close, this is possibly a Documenter issue.

odow commented 6 months ago

cc @goerz have you noticed this before?

Link: https://jump.dev/JuMP.jl/stable/background/bibliography/

goerz commented 6 months ago

I have not noticed this before (maybe because I don’t use dark mode), but seems like a CSS problem. I’ll have a look

goerz commented 6 months ago

I'm also seeing this in https://juliadocs.org/DocumenterCitations.jl/stable/gallery/#author_year_style

So it's not specific to any kind of JuMP settings, but something that should be fixed in the "recommended" CSS. The bullet point is just supposed to be invisible, but it seems to clash with something in the dark mode CSS.

goerz commented 6 months ago

Yeah, documenter-dark.css is overriding the list-style: none in citations.css with list-style: disc outside.

CleanShot 2024-03-08 at 12 23 34@2x

I guess it's because the documenter-dark.css gets loaded later? Maybe we have to mark the citatations.css settings as "important".

goerz commented 6 months ago

Adding important to the citations.css seems to do the trick:

.citation ul {
 padding: 0 0 2.25em 0;
 margin: 0;
 list-style: none !important;}

I'll make a DocumenterCitations release with a new recommendation for the CSS, but you'll have to change the citations.css file manually in your existing documentation (probably directly on the gh-pages branch).

goerz commented 6 months ago

This is "fixed" in the DocumenterCitations release v1.3.3 I just made. Although updating DocumenterCitations won't really do anything for you: you'll have to modify https://github.com/jump-dev/JuMP.jl/blob/master/docs/src/assets/citations.css (and also the citations.css in existing deployed versions of your documentation)

shayandavoodii commented 6 months ago

Would adding the !important to the citations.css of the dev version also result in fixing the upcoming versions? I want to ensure that no other .css modification is required for future releases, and the change will automatically be applied to the upcoming releases.

odow commented 6 months ago

Would adding the !important to the citations.css of the dev version also result in fixing the upcoming versions?

3706 edits master. That'll fix the dev docs and all future versions. It won't fix already published versions.

shayandavoodii commented 6 months ago

Would adding the !important to the citations.css of the dev version also result in fixing the upcoming versions?

3706 edits master. That'll fix the dev docs and all future versions. It won't fix already published versions.

Thank you so much. I got it.