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 theme change #158

Merged
merged 16 commits into from
Oct 15, 2024
Merged

Docs theme change #158

merged 16 commits into from
Oct 15, 2024

Conversation

JOJ0
Copy link
Owner

@JOJ0 JOJ0 commented Oct 9, 2024

Resolves #156

JOJ0 and others added 15 commits October 3, 2024 22:03
* Table row hover color not so "in your face"
* Adjust page title and top left title
* Leave some crap in css and conf.py to play around with, cleanup later
- Currently this commit shows what's furo's defaults!!!
- No customization required when features.rst tables specify width and
  align (defaults are centered/not-full-width)
- Leave CSS experiments in synadm.css commented out for now
- CSS with this theme should rather go to conf.py
  html_theme_options light/dark_css_variables...
if the site header is too tall, it interferes with pretty much all
elements of the site, slightly or very noticeably (e.g. when skipping to
headers in pages)

`navbar_align` being left is important at 960px width, because it just
so happens to not cause that (at least with inclusive sans). this is
tricky to get right though, opendyslexic needs
header_links_before_dropdown to be 1 so it doesn't cause an overflow

also hide the last link behind a "more" button to also reduce space
taken up
most pages show more levels upon scrolling, which isn't much useful
because there's usually only 1 header (h2?) before all the rest is
subheaders (h3?)
@JacksonChen666 JacksonChen666 self-requested a review October 9, 2024 09:57
@JacksonChen666 JacksonChen666 added the documentation Improvements or additions to documentation label Oct 9, 2024
This partially reverts commit e1dff9e.
@JOJ0
Copy link
Owner Author

JOJ0 commented Oct 9, 2024

Thanks for removing the furo theme adjustments in 12b41a7. The width definitely needs to go. About align: We could keep it, it's not wrong to set it and other themes have center as their default, see: sphinx-doc/sphinx#4550

Anyway I'm just noting it here in case we ever need it because pydata theme decides to follow that default at some point. We can merge like this, less clutter in features.rst is good.

@JacksonChen666
Copy link
Collaborator

(My review is still pending, I'm just doing other stuff right now)

Copy link
Collaborator

@JacksonChen666 JacksonChen666 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't think I have anything so *approves*

@JOJ0 JOJ0 merged commit 2eddfa4 into master Oct 15, 2024
2 checks passed
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.

Modernize the look of our generated docs
2 participants