Skip to content

[MRG+1] Updates entire website design #14849

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

Merged
merged 155 commits into from
Sep 21, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
155 commits
Select commit Hold shift + click to select a range
966bff8
WIP
thomasjpfan Aug 29, 2019
108046d
WIP
thomasjpfan Aug 29, 2019
1e7af43
WIP
thomasjpfan Aug 29, 2019
61bc8a4
WIP
thomasjpfan Aug 29, 2019
baf6cc3
DOC Updates website design
thomasjpfan Aug 30, 2019
9802914
Merge remote-tracking branch 'upstream/master' into scikit-learn-boot…
thomasjpfan Aug 30, 2019
3c7425e
REV
thomasjpfan Aug 30, 2019
707cbeb
STY Fix
thomasjpfan Aug 30, 2019
ca0d534
TST [doc build]
thomasjpfan Aug 30, 2019
f489304
REV No logos
thomasjpfan Aug 30, 2019
08ed442
TST [doc build]
thomasjpfan Aug 30, 2019
e893b33
DOC Adjust z-index of nav
thomasjpfan Aug 30, 2019
bd58d82
ENH Mobile first search [doc build]
thomasjpfan Aug 30, 2019
e06ccdd
BUG Fixes
thomasjpfan Aug 30, 2019
c119892
BUG Style fixes
thomasjpfan Aug 30, 2019
8df63a8
ENH Does not load mathjax in index
thomasjpfan Aug 30, 2019
d76b220
ENH Whatsnew badges
thomasjpfan Aug 30, 2019
dfb7998
TST [doc build]
thomasjpfan Aug 30, 2019
af8e709
ENH Enhances image display [doc build]
thomasjpfan Aug 30, 2019
776b130
ENH Fixes headerlink jumping [doc build]
thomasjpfan Aug 30, 2019
912522f
ENH Increases constrast between sidebar and main [doc build]
thomasjpfan Aug 30, 2019
686aa8f
ENH Table style fix [doc build]
thomasjpfan Aug 30, 2019
05786cb
ENH Adds back links to other versions [doc build]
thomasjpfan Aug 30, 2019
656572d
ENH Padding to search results [doc build]
thomasjpfan Aug 30, 2019
19d9831
ENH Color fixes [doc build]
thomasjpfan Aug 30, 2019
2091b28
ENH CSS sure is fun [doc build]
thomasjpfan Aug 30, 2019
d72ddc6
ENH CSS sure is fun [doc build]
thomasjpfan Aug 30, 2019
e941dbf
ENH UX is fun [doc build]
thomasjpfan Aug 30, 2019
9db2cde
ENH UX is fun [doc build]
thomasjpfan Aug 30, 2019
e6d1443
ENH Adds table of contents page [doc build]
thomasjpfan Aug 30, 2019
a884fe6
ENH Mobile title fix [doc build]
thomasjpfan Aug 30, 2019
9951315
ENH Link to anchor fix [doc build]
thomasjpfan Aug 30, 2019
945baac
ENH JS comments [doc build]
thomasjpfan Aug 30, 2019
2a0c744
ENH UX and css is fun [doc build]
thomasjpfan Aug 30, 2019
875534c
BUG Fixes broken link [doc build]
thomasjpfan Aug 30, 2019
2869aa5
ENH UX is awesome [doc build]
thomasjpfan Aug 30, 2019
ce5286d
ENH UX is awesome [doc build]
thomasjpfan Aug 30, 2019
92c0da3
ENH UX is awesome [doc build]
thomasjpfan Aug 30, 2019
6b47a1d
ENH Adds border to the right [doc build]
thomasjpfan Aug 31, 2019
ec89012
ENH Better anchor links support [doc build]
thomasjpfan Aug 31, 2019
f495c81
ENH Smaller header size [doc build]
thomasjpfan Aug 31, 2019
ee6e692
ENH Smarter anchor links [doc build]
thomasjpfan Aug 31, 2019
c7464ec
BUG Unhides navbar [doc build]
thomasjpfan Aug 31, 2019
a248647
ENH Auto hiding navbar [doc build]
thomasjpfan Sep 1, 2019
1dad349
ENH Nicer looking google search [doc build]
thomasjpfan Sep 1, 2019
28b6726
ENH Nicer looking landing [doc build]
thomasjpfan Sep 1, 2019
d735d5a
BUG Nowrap for code [doc build]
thomasjpfan Sep 1, 2019
cd79373
ENH Hide navbar if hashtarget is on top first load
thomasjpfan Sep 1, 2019
bd5279a
ENH Better navhide support for mobile [doc build]
thomasjpfan Sep 1, 2019
8f493a7
ENH Adds margins [doc build]
thomasjpfan Sep 1, 2019
70e893c
ENH Nicer google search [doc build]
thomasjpfan Sep 1, 2019
e18aff2
CLN Uses sk- naming convention [doc build]
thomasjpfan Sep 1, 2019
8854d77
ENH Dynamicaly adjusts navbar [doc build]
thomasjpfan Sep 1, 2019
9a3b054
ENH Locally scopes new javascript [doc build]
thomasjpfan Sep 1, 2019
4810676
CLN Media with screen [doc build]
thomasjpfan Sep 1, 2019
f4e6748
CLN Nicer google search box [doc build]
thomasjpfan Sep 1, 2019
ee306d3
ENH Pure css sidebar toggling
thomasjpfan Sep 2, 2019
97fc3c8
BUG Fix on html [doc build]
thomasjpfan Sep 2, 2019
58bf0dd
DOC Better padding [doc build]
thomasjpfan Sep 2, 2019
073dd5f
ENH Better style in documentation [doc build]
thomasjpfan Sep 2, 2019
3153e19
ENH Better image style in index [doc style]
thomasjpfan Sep 2, 2019
53ab67c
DOC Better padding [doc build]
thomasjpfan Sep 2, 2019
e3cd1a8
DOC Fix testimonials [doc build]
thomasjpfan Sep 2, 2019
a104e7c
ENH Adds whats new button on top [doc build]
thomasjpfan Sep 2, 2019
8c3995a
BUG Properly adds big_toc [doc build]
thomasjpfan Sep 2, 2019
89e8ac7
DOC Build pdf correctly [doc build]
thomasjpfan Sep 3, 2019
fbb102b
BUG Fix [doc build]
thomasjpfan Sep 3, 2019
92a18c0
CLN Remove a header
thomasjpfan Sep 3, 2019
73fca34
CLN Fix overflow
thomasjpfan Sep 4, 2019
fab734a
CLN Address comments
thomasjpfan Sep 6, 2019
fa15936
CLN Address comments
thomasjpfan Sep 7, 2019
06a228c
CLN Address comments
thomasjpfan Sep 7, 2019
3875090
Merge remote-tracking branch 'upstream/master' into scikit-learn-boot…
thomasjpfan Sep 7, 2019
743843d
CLN Address comments
thomasjpfan Sep 7, 2019
7d50bf2
CLN Displays depth 2 on sidebar
thomasjpfan Sep 7, 2019
9ce182a
DOC Make gradients great again
thomasjpfan Sep 7, 2019
958e4c8
DOC Update
thomasjpfan Sep 7, 2019
a7bd6e4
DOC More tab
thomasjpfan Sep 7, 2019
4d98793
DOC Adjusts padding
thomasjpfan Sep 7, 2019
1c15651
DOC Adjusts margins
thomasjpfan Sep 7, 2019
9513932
DOC Fixes choose the right estimator
thomasjpfan Sep 8, 2019
43b5e90
DOC Dynamic versioning
thomasjpfan Sep 8, 2019
6bb1e58
CLN Cleaner relinks
thomasjpfan Sep 8, 2019
76ea8c7
CLN Ligher background hover
thomasjpfan Sep 8, 2019
e8f1eab
STY more horizontal spacing on index (#9)
GaelVaroquaux Sep 8, 2019
a561fd8
CLN MORE WHITESPACE
thomasjpfan Sep 8, 2019
1c42af0
DOC Rename index
thomasjpfan Sep 8, 2019
03713b5
DOC More natural media
thomasjpfan Sep 9, 2019
2252ddb
DOC Change breakpoint
thomasjpfan Sep 9, 2019
38fb02e
DOC Fix CSS
thomasjpfan Sep 9, 2019
8306703
DOC Update quick start wording
thomasjpfan Sep 9, 2019
aedc135
DOC Slightly lesss dark button
thomasjpfan Sep 9, 2019
1f2ccbe
CLN Address comments
thomasjpfan Sep 9, 2019
d182ede
CLN Improves index image placement
thomasjpfan Sep 9, 2019
2b561b1
ENH Numbered examples
thomasjpfan Sep 9, 2019
b68ebe3
DOC Improves navigation for index toctree files
thomasjpfan Sep 9, 2019
c4811be
DOC Slightlu smaller more info landing
thomasjpfan Sep 9, 2019
0018ab8
STY: example download note to the right (#10)
GaelVaroquaux Sep 9, 2019
e1e2399
DOC Places example link next to content
thomasjpfan Sep 9, 2019
1d0e031
STY Image fix
thomasjpfan Sep 9, 2019
fa93d82
DOC Fix
thomasjpfan Sep 9, 2019
7e2396c
DOC Better table handling
thomasjpfan Sep 9, 2019
8b66de4
Bug Fix scrolling
thomasjpfan Sep 9, 2019
7a2cb5e
Merge remote-tracking branch 'upstream/master' into scikit-learn-boot…
thomasjpfan Sep 9, 2019
7eb75ad
DOC Fix global toc
thomasjpfan Sep 10, 2019
3a05bf6
BUG Fix header example linking
thomasjpfan Sep 10, 2019
65ce54c
STY Adds top
thomasjpfan Sep 10, 2019
70eba31
STY Fix navbar font
thomasjpfan Sep 10, 2019
9e65a0d
BUG Fixes minior bug scrolling for mobile
thomasjpfan Sep 10, 2019
758d441
STY Makes TOC arrow more touch friendly
thomasjpfan Sep 10, 2019
443cff4
BUG Nicer header behavior
thomasjpfan Sep 10, 2019
e2ba48a
CLN Remvoe debugging prints
thomasjpfan Sep 10, 2019
e9172d4
STY Slightly lower margin-top
thomasjpfan Sep 10, 2019
cf13dc7
DOC Show note in examples
thomasjpfan Sep 10, 2019
b9e7be2
STY Nicer touch target for TOC
thomasjpfan Sep 10, 2019
e7f16eb
STY Better scroll
thomasjpfan Sep 11, 2019
3e7a4b1
STY Better sidebar scrollbar placement
thomasjpfan Sep 11, 2019
2dbaaa1
STY Fix output
thomasjpfan Sep 11, 2019
1419573
DOC Fix download note
thomasjpfan Sep 11, 2019
79e1d1d
REV Examples depth
thomasjpfan Sep 11, 2019
8a68355
Trigger full CircleCI build [doc build]
lesteve Sep 12, 2019
158be27
BLD scroll bars in section [doc build]
thomasjpfan Sep 12, 2019
52890ec
BLD Addresses @lesteve comments
thomasjpfan Sep 12, 2019
732ae26
CLN Address @jnothman comments
thomasjpfan Sep 12, 2019
21d303b
STY: increase contrast (#11)
GaelVaroquaux Sep 13, 2019
d28735c
CLN Refactor nav list
thomasjpfan Sep 14, 2019
54c108d
ENH Adjust for lighthouse audit
thomasjpfan Sep 14, 2019
a81e2df
BUG Fix
thomasjpfan Sep 14, 2019
a23484b
Merge remote-tracking branch 'upstream/master' into scikit-learn-boot…
thomasjpfan Sep 14, 2019
d3bfc10
TST [doc build]
thomasjpfan Sep 14, 2019
d42e526
STY Fixes deprecated box
thomasjpfan Sep 14, 2019
4a52b3d
STY Adjust spacing
thomasjpfan Sep 14, 2019
8da8fca
STY versionchanged styping
thomasjpfan Sep 14, 2019
06494c1
ENH Better TOC nav [doc build]
thomasjpfan Sep 14, 2019
6c67570
STY Update styling [doc build]
thomasjpfan Sep 14, 2019
f240b44
STY Updates
thomasjpfan Sep 14, 2019
e06283b
TST [doc build]
thomasjpfan Sep 14, 2019
7750246
STY Slightly more shadow [doc build]
thomasjpfan Sep 14, 2019
9467986
STY Improves word-break on sidebar [doc build]
thomasjpfan Sep 14, 2019
2a0dcd8
STY Better wrapping [doc build]
thomasjpfan Sep 14, 2019
f097855
STY Adjust API classes style [doc build]
thomasjpfan Sep 15, 2019
e115c19
STY Minor for versionchanged
thomasjpfan Sep 17, 2019
d3f1a5c
STY CSS magic for api docs [doc build]
thomasjpfan Sep 17, 2019
e6a97db
BLD Update mathjax [doc build]
thomasjpfan Sep 17, 2019
7d7cb14
DOC Adds comments about global toc [doc build]
thomasjpfan Sep 17, 2019
7a8ad5f
DOC Adds comments about global toc [doc build]
thomasjpfan Sep 17, 2019
b98e72d
DOC Better alt names
thomasjpfan Sep 17, 2019
f786512
ENH Adds fixed navbar in mobile [doc build]
thomasjpfan Sep 17, 2019
664c221
MAINT Remove unused css [doc build]
thomasjpfan Sep 17, 2019
06da033
CLN Address comments
thomasjpfan Sep 20, 2019
f16659a
TST [doc build]
thomasjpfan Sep 20, 2019
ce78c21
Avoid images overflowing horizontally on small screens (#12)
GaelVaroquaux Sep 20, 2019
41b85eb
Merge remote-tracking branch 'upstream/master' into scikit-learn-boot…
thomasjpfan Sep 20, 2019
5232b36
TST [doc build]
thomasjpfan Sep 20, 2019
0478a28
DOC Adds getting started [doc build]
thomasjpfan Sep 21, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 10 additions & 17 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,8 @@
imgmath_image_format = 'svg'
else:
extensions.append('sphinx.ext.mathjax')
mathjax_path = ('https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/'
'MathJax.js?config=TeX-AMS_SVG')

mathjax_path = ('https://cdn.jsdelivr.net/npm/mathjax@3/es5/'
'tex-chtml.js')

autodoc_default_options = {
'members': True,
Expand All @@ -74,7 +73,7 @@
#source_encoding = 'utf-8'

# The master toctree document.
master_doc = 'index'
master_doc = 'contents'

# General information about the project.
project = 'scikit-learn'
Expand Down Expand Up @@ -130,14 +129,13 @@

# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
html_theme = 'scikit-learn'
html_theme = 'scikit-learn-modern'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {'oldversion': False, 'collapsiblesidebar': True,
'google_analytics': True, 'surveybanner': False,
'sprintbanner': True, 'body_max_width': None}
html_theme_options = {'google_analytics': True,
'mathjax_path': mathjax_path}

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['themes']
Expand Down Expand Up @@ -173,7 +171,8 @@

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
html_additional_pages = {'index': 'index.html',
'documentation': 'documentation.html'}

# If false, no module index is generated.
html_domain_indices = False
Expand Down Expand Up @@ -217,7 +216,7 @@
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [('index', 'user_guide.tex', 'scikit-learn user guide',
latex_documents = [('contents', 'user_guide.tex', 'scikit-learn user guide',
'scikit-learn developers', 'manual'), ]

# The name of an image file (relative to this directory) to place at the top of
Expand Down Expand Up @@ -279,11 +278,7 @@
# thumbnails for the front page of the scikit-learn home page.
# key: first image in set
# values: (number of plot in set, height of thumbnail)
carousel_thumbs = {'sphx_glr_plot_classifier_comparison_001.png': 600,
'sphx_glr_plot_anomaly_comparison_001.png': 372,
'sphx_glr_plot_gpr_co2_001.png': 350,
'sphx_glr_plot_adaboost_twoclass_001.png': 372,
'sphx_glr_plot_compare_methods_001.png': 349}
carousel_thumbs = {'sphx_glr_plot_classifier_comparison_001.png': 600}


# enable experimental module so that experimental estimators can be
Expand Down Expand Up @@ -314,8 +309,6 @@ def make_carousel_thumbs(app, exception):

def setup(app):
# to hide/show the prompt in code examples:
app.add_javascript('js/copybutton.js')
app.add_javascript('js/extra.js')
app.connect('build-finished', make_carousel_thumbs)


Expand Down
23 changes: 23 additions & 0 deletions doc/contents.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
.. include:: includes/big_toc_css.rst
.. include:: tune_toc.rst

.. Places global toc into the sidebar
:globalsidebartoc: True

=================
Table Of Contents
=================

.. Define an order for the Table of Contents:

Copy link
Member

Choose a reason for hiding this comment

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

Does this want big_toc_css for consistency?

.. toctree::
:maxdepth: 2

preface
tutorial/index
getting_started
user_guide
glossary
auto_examples/index
modules/classes
developers/index
1 change: 1 addition & 0 deletions doc/data_transforms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ transformations of the target space (e.g. categorical labels) for use in
scikit-learn.

.. toctree::
:maxdepth: 2

modules/compose
modules/feature_extraction
Expand Down
3 changes: 3 additions & 0 deletions doc/developers/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. Places global toc into the sidebar
:globalsidebartoc: True

.. _developers_guide:

=================
Expand Down
117 changes: 0 additions & 117 deletions doc/documentation.rst

This file was deleted.

Binary file added doc/images/columbia-small.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/fnrs-logo-small.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/google-small.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/inria-small.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/scikit-learn-logo-small.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/sloan_logo-small.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/sydney-stacked-small.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/telecom-small.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 20 additions & 24 deletions doc/includes/big_toc_css.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,38 +5,34 @@
.. raw:: html

<style type="text/css">
div.bodywrapper blockquote {
margin: 0 ;
div.body div.toctree-wrapper ul {
padding-left: 0;
}

div.toctree-wrapper ul {
margin-top: 0 ;
margin-bottom: 0 ;
padding-left: 10px ;
}

li.toctree-l1 {
padding: 0 0 0.5em 0 ;
div.body li.toctree-l1 {
padding: 0 0 0.5em 0;
list-style-type: none;
font-size: 150% ;
font-weight: bold;
}

li.toctree-l1 ul {
padding-left: 40px ;
font-size: 150%;
font-weight: bold;
}

li.toctree-l2 {
font-size: 70% ;
div.body li.toctree-l2 {
font-size: 70%;
list-style-type: square;
font-weight: normal;
}
font-weight: normal;
margin-left: 40px;
}

li.toctree-l3 {
font-size: 85% ;
div.body li.toctree-l3 {
font-size: 85%;
list-style-type: circle;
font-weight: normal;
}
font-weight: normal;
margin-left: 40px;
}

div.body li.toctree-l4 {
margin-left: 40px;
}

</style>

Expand Down
Loading