Introduce NewOcean theme #782
Conversation
|
I am currently looking at the documentation for haddock-library, generated with this patch and I see the following:
The |
|
on this branch it looks like the datafiles need to be updated? in |
|
Also nuno has some new assets for synopsis, plus, and minus that haven't been pulled in. And I think there are a few more css changes he'd like to make, if people like them. (i.e. at least the font and footer stuff from haskell/hackage-server#731) |
|
OK. Have you checked how type classes are displayed?
gbaz <[email protected]> schrieb am Mo., 26. März 2018, 21:11:
… Also nuno has some new assets for synopsis, plus, and minus that haven't
been pulled in.
And I think there are a few more css changes he'd like to make, if people
like them. (i.e. at least the font and footer stuff from
haskell/hackage-server#731
<haskell/hackage-server#731>)
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#782 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AByiiWaMXcKbho-cMWH7ZCMhZNWHu22_ks5tiT1fgaJpZM4SzMdi>
.
|
|
Oh yes, I think I see the concern. @NunoAlexandre it looks like we've lost a lot of indentation in these cases, making things harder to visually distinguish. e.g. before: after: The same occurs with methods and instances:
Also, in the above, the grey background of methods extends very far -- further even than the grey background of the instances bit itself. Weird... |
|
Also, by the way, the new plus and minus signs look quite nice in the haddocks proper, but I'm not so sure how they look in the generated contents?
|
|
A few issues when swapping themes. First, if we use the new html with the old Ocean theme, the right-hand menu looks bad in the topbar (the text is pushed down, and since it is white, it is not visible at all:
A small tweak to the Ocean.css to fix this would be good. Similarly for the Classic theme (not that anybody probably uses it):
(@NunoAlexandre what do you think about just reverting that small html change to the topbar and having the new css work with the existing one so we can leave prior stylesheets unchanged? I know the menu will not reflow quite as nicely, but it seems it might be simpler overall, and allow more free switching...) Second, if we build docs with
|
|
What the status here? |
|
Hi @alexbiehl, I plan to do some work here this weekend 👍 |
|
@alexbiehl now this PR is on a branch on your own account. To edit this, I would need to fork your haddock repo and open a PR against it there. How do you suggest to do this instead?
Why are we going to get our selves stuck because of such an old and unused theme? I don't quite like this theme toggle option idea either, to be honest. There's a reason we don't see it anywhere. One of the ideas behind this redesign is to have a consistent look, doing this is promoting exactly the opposite and making maintenance even harder. In the worst case, we can update the old stylesheet to work well with the new html changes instead. |
|
@NunoAlexandre I will give you access. Should be easiest, right? |
|
Yes, thanks! |
|
I have updated this stylesheet with the latest state from hackage and have addresses other issues pointed out above, namely the indentation on code blocks. @alexbiehl I could not reproduce you issue reported above (#782 (comment)). I tried pasting the latest CSS code into the live version of that page and the You can have a look at some previews here.. Make sure to hard refresh to get the latest version of the stylesheet instead of a cached one. About the backward compatibility point, I will wait for your response to my comment above. Thanks! |
Nuno -- yes, this was my first proposal. I don't really care if we change the old css slightly or change the new html gen slightly, but it would be bad to break this feature for those who still want it. I'm happy with either solution you pick. It just seemed the case to me that the topbar html change was not that significant :-) We really should fix the htmlgen to put back the theme-switcher js though. Again, it might not be the wisest feature, but it works, and its straightforward to keep working, and I guarantee there are people that will be frustrated if it stops being supported, so better to just cover their use case. |
|
@NunoAlexandre great! One thing I noticed is that synopsis is still the old one.
|
|
@alexbiehl could you point me to a page where that happens? I can imagine an older version of the html causing that difference, but I have tried a few packages with the new stylesheet and it's always looking as expected. @gbaz alright 👌 |
|
@alexbiehl could you also assign me to this PR? thanks! |
|
I have adjusted the html changes so that it is backward-compatible. I think now I just have to double check that different synopsis and I guess we are good to go after - at least for a first release. |
|
@NunoAlexandre did you put back the js that lets the switcher work too? Also do you think the generated contents in the package index page look ok? |
|
fd@gbaz I am not sure I understand the issue. I didn't remove any JS file or touched anything related to that switcher, neither did I ever see it live. Could you let me know where to look at and what's the background here?
I am not sure if by Thanks! |
NunoAlexandre
force-pushed
the
pe/new-ocean
branch
from
23d6b19
to
9cd66ed
Compare
|
@NunoAlexandre seems like your editor was a bit too eager with trailing whitespaces. These seem to be expected by haddock. (I will open an issue to strip whitespace from table cells) |
|
@NunoAlexandre sorry it took me a while. re the switcher, the main point is described at #782 (comment). If you build haddocks with the Regarding "contents" I meant the module listing generated for each package, which I included a screenshot of at: #782 (comment) |
|
@alexbiehl you are right, sorry :/ how can I get to build this branch? The easiest way to update the ref files is by running the tests and then move the Since I believe you are able to build this branch, and if you have the time, if you could do this yourself it would be great. |
- Fix and improve spacing - Improve colors and borders
The current html generator of this branch wraps the package-header caption as a div, which does not work (without style adjustments) with the old themes. Changing it from div to span does the trick, without needing to adjust the old stylesheets.
NunoAlexandre
force-pushed
the
pe/new-ocean
branch
from
9cd66ed
to
1289a62
Compare
|
@alexbiehl since you can build this branch locally if you could update the ref tests yourself that'd be great (by moving the I have tried following your suggestion but I have hiccups at every step. I tried installing a ghc-8.4-* but after that, the setup always failed due to parsing errors around I've become a father recently thus my lack of time to work on this. Thanks already. |
|
@NunoAlexandre no worries. We will take care of it. (The error message indicates you are not building with ghc-8.4.* but with a ghc-8.0.*) |
|
I have some time to spend on this, but I'm not sure what in particular I should look at. Any suggestions? |
|
When I try to build the haddocks for Not sure what to do about this. |
|
You need to pass haddock resource path to the invocation.
"-Lhaddock-api/resources.
Simon Jakobi <[email protected]> schrieb am Do., 31. Mai 2018, 17:15:
… When I try to build the haddocks for these I get
≻ cabal new-haddock --with-haddock=/home/simon/src/haddock/dist-newstyle/build/x86_64-linux/ghc-8.4.2/haddock-2.20.0/x/haddock/noopt/build/haddock/haddock
...
Haddock's resource directory does not exist!
cabal: Failed to build documentation for these-0.7.4.
Not sure what to do about this.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#782 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AByiiYkB8OkXTrdiKgyE_SZs9s3L_slOks5t4AkRgaJpZM4SzMdi>
.
|
Thanks, Alex! It's lowercase |
|
I have accepted the changes in html-test and hopefully fixed the data-files section. The patch is at alexbiehl#1. What I don't understand is why after changing the data-files section, html-test is again failing, but only when run with cabal new-test. See diff.txt. When running I don't see these failures. |
|
Regarding the styling I'm still seeing the following problems: In this case I think the fonts in the Contents-box is relatively too small. But maybe scaling down the main font would be the preferable solution, as it seems quite large to me.
In this case the module info seems to take too much space at the top:
In this case a bit more indentation (not sure if that's the right word) for the docs would help each declaration stand out more. |
|
Regarding building and running the tests, try this or a variant If ghc-8.4.2 is not on your PATH, you can pass in the full path to some ghc v8.4.* |
I think that was because I ran html-test without the |
|
With regards to the problems, I think a number of assets still have not been properly moved into the correct location for this pr. cf: https://github.com/alexbiehl/haddock/blob/1289a62e9c15377ca591f176291c23d497b7e3d2/haddock-api/resources/html/NewOcean.std-theme/synopsis.png In general, it should be double-checked that all the png assets in the NewOcean theme are actually the ones from Nuno and not just copied over from Ocean, as I think they all were in this PR. |
|
@sjakobi outside of the asset issue, which really needs fixing, it seems your other comments are not obvious outright bugs, but rather design considerations with regards to spacing, size, etc? Is this correct? I'd like to triage to make sure we all understand the situation. |
Right, but where are Nuno's png assets?
Well, I'd call the misplaced synopsis button a bug, but yes, what I pointed out are design issues. |
|
Hm, it seems like its not an asset question per-se, but rather that the css just shouldn't be making use of that png at all. E.g. compare to the source at https://nunoalexandre.com/pets/haddock/Control.Lens.Operators.html where its clear that the two uses of synopsis.png in the css are vestigal and shouldn't actually be invoked from anywhere. I guess something went a bit screwy in the merge? With that synopsis style, I think the placement is not a bug, but correct? The problem is just that the css for it makes it look wrong at that location until we remove the weird png, etc. |
|
I don't use assets, but just Unicode with |
|
This PR is dying. It was pretty ready to go until the decision of being backwards-compatible was made and delayed it all. Which, as I said above, seems pretty worthless to me. Moving forward, how can we get this one merged? I didn't managet to get a build with the right ghc, and no proper documentation is to be found at all (or I didn't search well). Could you document how to build and test this project using a specific ghc version? I then can look into the comments raised about about the UI. |
Let's revive it! The community obviously seemed to care about these changes, so it would be a shame to let them bitrot.
With a recent version of cabal you should be able to just run the following to build and test. I just tried this right now and it worked (although there are tests failing due to whitespace differences). If you don't have If that doesn't work, could you paste in the error message you get? |
|
Can someone summarize what still needs to be done? Btw, if it makes things easier, mark suggests dropping support for style-switcher stuff in general... #810 (comment) |
|
@alexbiehl I may have a little time to roll up my sleeves and help out here if you let me know what you think the situation is? (in terms of what remains?) |
|
Any update on this? Seems like it's been some time since last post on this PR. |
|
Superseded by #949. |
These are the rebased commits from #721 on the ghc-8.4 branch. The only change I made was putting them into NewOcean.std-theme to preserve the old Ocean theme.
/cc @NunoAlexandre @gbaz @hvr