Skip to content

Backport PR #31156 on branch 1.0.x (DOC: Update of the 'getting started' pages in the sphinx section of the documentation) #32052

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
5,273 changes: 5,273 additions & 0 deletions doc/data/air_quality_long.csv

Large diffs are not rendered by default.

1,036 changes: 1,036 additions & 0 deletions doc/data/air_quality_no2.csv

Large diffs are not rendered by default.

2,069 changes: 2,069 additions & 0 deletions doc/data/air_quality_no2_long.csv

Large diffs are not rendered by default.

8 changes: 8 additions & 0 deletions doc/data/air_quality_parameters.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
id,description,name
bc,Black Carbon,BC
co,Carbon Monoxide,CO
no2,Nitrogen Dioxide,NO2
o3,Ozone,O3
pm10,Particulate matter less than 10 micrometers in diameter,PM10
pm25,Particulate matter less than 2.5 micrometers in diameter,PM2.5
so2,Sulfur Dioxide,SO2
1,111 changes: 1,111 additions & 0 deletions doc/data/air_quality_pm25_long.csv

Large diffs are not rendered by default.

67 changes: 67 additions & 0 deletions doc/data/air_quality_stations.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
location,coordinates.latitude,coordinates.longitude
BELAL01,51.23619,4.38522
BELHB23,51.1703,4.341
BELLD01,51.10998,5.00486
BELLD02,51.12038,5.02155
BELR833,51.32766,4.36226
BELSA04,51.31393,4.40387
BELWZ02,51.1928,5.22153
BETM802,51.26099,4.4244
BETN016,51.23365,5.16398
BETR801,51.20966,4.43182
BETR802,51.20952,4.43179
BETR803,51.22863,4.42845
BETR805,51.20823,4.42156
BETR811,51.2521,4.49136
BETR815,51.2147,4.33221
BETR817,51.17713,4.41795
BETR820,51.32042,4.44481
BETR822,51.26429,4.34128
BETR831,51.3488,4.33971
BETR834,51.092,4.3801
BETR891,51.25581,4.38536
BETR893,51.28138,4.38577
BETR894,51.2835,4.3495
BETR897,51.25011,4.3421
FR04004,48.89167,2.34667
FR04012,48.82778,2.3275
FR04014,48.83724,2.3939
FR04014,48.83722,2.3939
FR04031,48.86887,2.31194
FR04031,48.86889,2.31194
FR04037,48.82861,2.36028
FR04060,48.8572,2.2933
FR04071,48.8564,2.33528
FR04071,48.85639,2.33528
FR04118,48.87027,2.3325
FR04118,48.87029,2.3325
FR04131,48.87333,2.33028
FR04135,48.83795,2.40806
FR04135,48.83796,2.40806
FR04141,48.85278,2.36056
FR04141,48.85279,2.36056
FR04143,48.859,2.351
FR04143,48.85944,2.35111
FR04179,48.83038,2.26989
FR04329,48.8386,2.41279
FR04329,48.83862,2.41278
Camden Kerbside,51.54421,-0.17527
Ealing Horn Lane,51.51895,-0.26562
Haringey Roadside,51.5993,-0.06822
London Bexley,51.46603,0.18481
London Bloomsbury,51.52229,-0.12589
London Eltham,51.45258,0.07077
London Haringey Priory Park South,51.58413,-0.12525
London Harlington,51.48879,-0.44161
London Harrow Stanmore,51.61733,-0.29878
London Hillingdon,51.49633,-0.46086
London Marylebone Road,51.52253,-0.15461
London N. Kensington,51.52105,-0.21349
London Teddington,51.42099,-0.33965
London Teddington Bushy Park,51.42529,-0.34561
London Westminster,51.49467,-0.13193
Southend-on-Sea,51.5442,0.67841
Southwark A2 Old Kent Road,51.4805,-0.05955
Thurrock,51.47707,0.31797
Tower Hamlets Roadside,51.52253,-0.04216
Groton Fort Griswold,41.3536,-72.0789
892 changes: 892 additions & 0 deletions doc/data/titanic.csv

Large diffs are not rendered by default.

251 changes: 251 additions & 0 deletions doc/source/_static/css/getting_started.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,251 @@
/* Getting started pages */

/* data intro */
.gs-data {
font-size: 0.9rem;
}

.gs-data-title {
align-items: center;
font-size: 0.9rem;
}

.gs-data-title .badge {
margin: 10px;
padding: 5px;
}

.gs-data .badge {
cursor: pointer;
padding: 10px;
border: none;
text-align: left;
outline: none;
font-size: 12px;
}

.gs-data .btn {
background-color: grey;
border: none;
}

/* note/alert properties */

.alert-heading {
font-size: 1.2rem;
}

/* callout properties */
.gs-callout {
padding: 20px;
margin: 20px 0;
border: 1px solid #eee;
border-left-width: 5px;
border-radius: 3px;
}
.gs-callout h4 {
margin-top: 0;
margin-bottom: 5px;
}
.gs-callout p:last-child {
margin-bottom: 0;
}
.gs-callout code {
border-radius: 3px;
}
.gs-callout+.gs-callout {
margin-top: -5px;
}
.gs-callout-remember {
border-left-color: #f0ad4e;
align-items: center;
font-size: 1.2rem;
}
.gs-callout-remember h4 {
color: #f0ad4e;
}

/* reference to user guide */
.gs-torefguide {
align-items: center;
font-size: 0.9rem;
}

.gs-torefguide .badge {
background-color: #130654;
margin: 10px 10px 10px 0px;
padding: 5px;
}

.gs-torefguide a {
margin-left: 5px;
color: #130654;
border-bottom: 1px solid #FFCA00f3;
box-shadow: 0px -10px 0px #FFCA00f3 inset;
}

.gs-torefguide p {
margin-top: 1rem;
}

.gs-torefguide a:hover {
margin-left: 5px;
color: grey;
text-decoration: none;
border-bottom: 1px solid #b2ff80f3;
box-shadow: 0px -10px 0px #b2ff80f3 inset;
}

/* question-task environment */

ul.task-bullet, ol.custom-bullet{
list-style:none;
padding-left: 0;
margin-top: 2em;
}

ul.task-bullet > li:before {
content:"";
height:2em;
width:2em;
display:block;
float:left;
margin-left:-2em;
background-position:center;
background-repeat:no-repeat;
background-color: #130654;
border-radius: 50%;
background-size:100%;
background-image:url('../question_mark_noback.svg');
}

ul.task-bullet > li {
border-left: 1px solid #130654;
padding-left:1em;
}

ul.task-bullet > li > p:first-child {
font-size: 1.1rem;
padding-left: 0.75rem;
}

/* Getting started index page */

.intro-card {
background:#FFF;
border-radius:0;
padding: 30px 10px 10px 10px;
margin: 10px 0px;
}

.intro-card .card-text {
margin:20px 0px;
/*min-height: 150px; */
}

.intro-card .card-img-top {
margin: 10px;
}

.install-block {
padding-bottom: 30px;
}

.install-card .card-header {
border: none;
background-color:white;
color: #150458;
font-size: 1.1rem;
font-weight: bold;
padding: 1rem 1rem 0rem 1rem;
}

.install-card .card-footer {
border: none;
background-color:white;
}

.install-card pre {
margin: 0 1em 1em 1em;
}

.custom-button {
background-color:#DCDCDC;
border: none;
color: #484848;
text-align: center;
text-decoration: none;
display: inline-block;
font-size: 0.9rem;
border-radius: 0.5rem;
max-width: 120px;
padding: 0.5rem 0rem;
}

.custom-button a {
color: #484848;
}

.custom-button p {
margin-top: 0;
margin-bottom: 0rem;
color: #484848;
}

/* intro to tutorial collapsed cards */

.tutorial-accordion {
margin-top: 20px;
margin-bottom: 20px;
}

.tutorial-card .card-header.card-link .btn {
margin-right: 12px;
}

.tutorial-card .card-header.card-link .btn:after {
content: "-";
}

.tutorial-card .card-header.card-link.collapsed .btn:after {
content: "+";
}

.tutorial-card-header-1 {
justify-content: space-between;
align-items: center;
}

.tutorial-card-header-2 {
justify-content: flex-start;
align-items: center;
font-size: 1.3rem;
}

.tutorial-card .card-header {
cursor: pointer;
background-color: white;
}

.tutorial-card .card-body {
background-color: #F0F0F0;
}

.tutorial-card .badge {
background-color: #130654;
margin: 10px 10px 10px 10px;
padding: 5px;
}

.tutorial-card .gs-badge-link p {
margin: 0px;
}

.tutorial-card .gs-badge-link a {
color: white;
text-decoration: none;
}

.tutorial-card .badge:hover {
background-color: grey;
}
14 changes: 14 additions & 0 deletions doc/source/_static/logo_r.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions doc/source/_static/logo_sas.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading