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

furo docs theme #1290

Merged
merged 25 commits into from
Feb 14, 2022
Merged

furo docs theme #1290

merged 25 commits into from
Feb 14, 2022

Conversation

adamgayoso
Copy link
Member

@adamgayoso adamgayoso commented Dec 13, 2021

New features

View built docs on this branch here (best to do in private window due to browser caching)

Everything generally looks good in both light and dark mode. We can force white backgrounds on images in the first cell of tutorials to make those look good in dark mode. We can also refactor the notebook gallery images in a future release.

@codecov
Copy link

codecov bot commented Dec 13, 2021

Codecov Report

Merging #1290 (7505b12) into master (d117b1c) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1290   +/-   ##
=======================================
  Coverage   90.81%   90.81%           
=======================================
  Files         109      109           
  Lines        8263     8263           
=======================================
  Hits         7504     7504           
  Misses        759      759           
Impacted Files Coverage Δ
scvi/model/_autozi.py 98.83% <ø> (ø)
scvi/model/_destvi.py 88.28% <ø> (ø)
scvi/model/_peakvi.py 88.88% <ø> (ø)
scvi/model/_scanvi.py 93.27% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d117b1c...7505b12. Read the comment docs.

@galenxing
Copy link
Contributor

Looks cool! Would be nice if the api methods were all one liners in the left side bar (e.g. make the text smaller or make the sidebar larger).

@adamgayoso adamgayoso marked this pull request as ready for review February 14, 2022 04:50
@adamgayoso adamgayoso changed the title [WIP] furo docs theme furo docs theme Feb 14, 2022
@adamgayoso
Copy link
Member Author

Looks cool! Would be nice if the api methods were all one liners in the left side bar (e.g. make the text smaller or make the sidebar larger).

This should be fixed now

@watiss
Copy link
Contributor

watiss commented Feb 14, 2022

I think I like our current one a little better, but this is also nice.

Couple of notes:

  • Some tutorial features seem broken in dark mode, such as this umap:

Screen Shot 2022-02-13 at 11 02 36 PM

  • Should we have a side menu drop-down for User guides like we do for Tutorials?

@adamgayoso
Copy link
Member Author

Should we have a side menu drop-down for User guides like we do for Tutorials?

I removed this because it's going to be too long eventually -- scikit-learn and pytorch do not make use of long content sidebars

@watiss The images will be rerun when we rerun all the tutorials and white background on images will be forced.

@justjhong
Copy link
Contributor

Dark mode boxes could be slightly lighter here
image

Also these boxes can just match the ones on the homepage if possible (or change from images to badges to make it even simpler
image

Otherwise I'm a big fan of this new theme!

@adamgayoso adamgayoso enabled auto-merge (squash) February 14, 2022 21:07
@adamgayoso adamgayoso merged commit 4887b17 into master Feb 14, 2022
@adamgayoso adamgayoso deleted the furo branch May 10, 2022 04:29
nrclaudio pushed a commit to nrclaudio/scvi-tools-tune that referenced this pull request Jun 21, 2022
* furo initial

* css

* update furo

* nb padding

* update furo version

* remove tocs

* github to toc

* fix rtd?

* no sphinx 44

* force

* add new index page

* opengraph

* add back long tocs

* no toc user guide

* toc smaller fonts lower level

* fix broken links

* gallery nice on dark mode

* update versions

* 3.8

* see if rtd uses override

* better communicate in tutorials

* sphinx design shadow

* correct css

* update furo version
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

Successfully merging this pull request may close these issues.

Add doc extension for link preview
4 participants