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

Adopt DataLad colors #38

Closed
mih opened this issue Jul 1, 2019 · 4 comments
Closed

Adopt DataLad colors #38

mih opened this issue Jul 1, 2019 · 4 comments

Comments

@mih
Copy link
Collaborator

mih commented Jul 1, 2019

ATM the theme sphinx uses for HTML and PDF output is using the default colors. However, even now there is a figure included that uses the color scheme we have adopted for DataLad elsewhere (website, posters https://f1000research.com/posters/7-1965).

I would make sense to me to adopt the same colors also for the book (notes, todos, highlights, etc.). Let me know, and I'll give it a go.

@mih mih added the question Further information is requested label Jul 1, 2019
@adswa
Copy link
Contributor

adswa commented Jul 1, 2019

I think that is a very good idea. tbh I've been interestly eying other sphinx themes just because the have a more datalad-like color scheme -- but if we can get the DataLad color into this theme, even better!

@mih mih self-assigned this Jul 1, 2019
@mih
Copy link
Collaborator Author

mih commented Jul 3, 2019

The HTML version already has some of this now. The PDF needs more attention.

Latex color setup is detailed here: http://www.sphinx-doc.org/en/master/latex.html#sphinxsetup-key

@mih mih removed the question Further information is requested label Jul 3, 2019
@mih mih changed the title Adopt DataLad colors? Adopt DataLad colors Jul 3, 2019
@mih mih removed their assignment Jul 3, 2019
@adswa adswa mentioned this issue Dec 3, 2019
@adswa
Copy link
Contributor

adswa commented Jan 14, 2020

I'm adding a few more issues that the PDF has here. I don't think that they are urgent, but I believe they must be annoying or confusing if one reads only the PDF:

  • findoutmore directives are expanded, but not distinguishable in any way from the rest of the content. It would be cool if we could at least give them another background color. As far as I can see, this doesn't work with any of the keys that Sphinx provides for the Latex customization
  • The same is true for gitusernotes
  • The PDF labels book parts differently from how we refer to them in the text. Every .rst file is a "chapter" (we call them sections), hence we currently have 58 chapters. The next-level grouping into what we call "chapters" (e.g. "DataLad Datasets" with sections 101-101-create until 101-107-summary) are called "part" in the PDF, hence we currently have 15 parts. One of those parts is the Introduction, 1 part is the usecases, and 9 parts are currently the Basics. I don't see how we could configure the PDF to be in line with how we call the different parts. One solution could be to add a "If you are reading the PDF version, be mindful..." paragraph to the "How to read the handbook" section. This could be done with .. only:: latexpdf to have it not rendered in the html version even. Alternatively, we may need to reconsider our wording and adjust it towards the Latex naming.
  • the cheatsheet is too large for a single PDF page. Instead of previewing the cheatsheet in full, we could include one figure per cheat sheet page, so that the cheat sheet are several successive pages in the PDF
  • sections that are "hidden" via
.. toctree::
   :hidden:

actually do show up in the book. Its not the case for .. only:: adminmode parts

  • While figures are nicely sized in the html version, they are sometimes distractingly large or small in the PDF output. And, weirdly, some pictures do not show up in the PDF all, for example line 567 in 101-130-yodaproject.rst (have not investigated this further)

@adswa
Copy link
Contributor

adswa commented May 18, 2020

I AM SO F**** HAPPY THAT I CAN CLOSE THIS FINALLY. #469 took care of it. It will not win a design award, but its finally properly readable. 🎉

@adswa adswa closed this as completed May 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants