Skip to content

Commit 112963c

Browse files
committed
Update docs
1 parent 184af2a commit 112963c

37 files changed

+15662
-3780
lines changed

0.4/.buildinfo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 5d2632d2fbe792265ca773e6a51b93f0
3+
config: 7db92125069190747434f1095b430195
44
tags: d77d1c0d9ca2f4c8421862c7c5a0d620

0.4/_sources/tutorials/getting-started-gurobipy.ipynb.txt

+2-8
Original file line numberDiff line numberDiff line change
@@ -45,16 +45,10 @@
4545
"- Python version, compatible with the Pyomo and Gurobipy modeling languages,\n",
4646
"- Julia version, compatible with the JuMP modeling language.\n",
4747
"\n",
48-
"In this tutorial, we will demonstrate how to use and install the Python/Gurobipy version of the package. The first step is to install Python 3.8+ in your computer. See the [official Python website for more instructions](https://www.python.org/downloads/). After Python is installed, we proceed to install MIPLearn using `pip`:\n",
48+
"In this tutorial, we will demonstrate how to use and install the Python/Gurobipy version of the package. The first step is to install Python 3.9+ in your computer. See the [official Python website for more instructions](https://www.python.org/downloads/). After Python is installed, we proceed to install MIPLearn using `pip`:\n",
4949
"\n",
5050
"```\n",
51-
"$ pip install MIPLearn==0.4\n",
52-
"```\n",
53-
"\n",
54-
"In addition to MIPLearn itself, we will also install Gurobi 10.0, a state-of-the-art commercial MILP solver. This step also install a demo license for Gurobi, which should able to solve the small optimization problems in this tutorial. A license is required for solving larger-scale problems.\n",
55-
"\n",
56-
"```\n",
57-
"$ pip install 'gurobipy>=10,<10.1'\n",
51+
"$ pip install MIPLearn~=0.4\n",
5852
"```"
5953
]
6054
},

0.4/_sources/tutorials/getting-started-pyomo.ipynb.txt

+2-8
Original file line numberDiff line numberDiff line change
@@ -45,16 +45,10 @@
4545
"- Python version, compatible with the Pyomo and Gurobipy modeling languages,\n",
4646
"- Julia version, compatible with the JuMP modeling language.\n",
4747
"\n",
48-
"In this tutorial, we will demonstrate how to use and install the Python/Pyomo version of the package. The first step is to install Python 3.8+ in your computer. See the [official Python website for more instructions](https://www.python.org/downloads/). After Python is installed, we proceed to install MIPLearn using `pip`:\n",
48+
"In this tutorial, we will demonstrate how to use and install the Python/Pyomo version of the package. The first step is to install Python 3.9+ in your computer. See the [official Python website for more instructions](https://www.python.org/downloads/). After Python is installed, we proceed to install MIPLearn using `pip`:\n",
4949
"\n",
5050
"```\n",
51-
"$ pip install MIPLearn==0.4\n",
52-
"```\n",
53-
"\n",
54-
"In addition to MIPLearn itself, we will also install Gurobi 10.0, a state-of-the-art commercial MILP solver. This step also install a demo license for Gurobi, which should able to solve the small optimization problems in this tutorial. A license is required for solving larger-scale problems.\n",
55-
"\n",
56-
"```\n",
57-
"$ pip install 'gurobipy>=10,<10.1'\n",
51+
"$ pip install MIPLearn~=0.4\n",
5852
"```"
5953
]
6054
},
-221 Bytes
Binary file not shown.
202 Bytes
Binary file not shown.

0.4/_static/basic.css

+49-113
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx stylesheet -- basic theme.
66
*
7-
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/
@@ -130,7 +130,7 @@ ul.search li a {
130130
font-weight: bold;
131131
}
132132

133-
ul.search li p.context {
133+
ul.search li div.context {
134134
color: #888;
135135
margin: 2px 0 0 30px;
136136
text-align: left;
@@ -222,7 +222,7 @@ table.modindextable td {
222222
/* -- general body styles --------------------------------------------------- */
223223

224224
div.body {
225-
min-width: 360px;
225+
min-width: 450px;
226226
max-width: 800px;
227227
}
228228

@@ -237,8 +237,14 @@ a.headerlink {
237237
visibility: hidden;
238238
}
239239

240-
a:visited {
241-
color: #551A8B;
240+
a.brackets:before,
241+
span.brackets > a:before{
242+
content: "[";
243+
}
244+
245+
a.brackets:after,
246+
span.brackets > a:after {
247+
content: "]";
242248
}
243249

244250
h1:hover > a.headerlink,
@@ -329,16 +335,12 @@ p.sidebar-title {
329335
font-weight: bold;
330336
}
331337

332-
nav.contents,
333-
aside.topic,
334338
div.admonition, div.topic, blockquote {
335339
clear: left;
336340
}
337341

338342
/* -- topics ---------------------------------------------------------------- */
339343

340-
nav.contents,
341-
aside.topic,
342344
div.topic {
343345
border: 1px solid #ccc;
344346
padding: 7px;
@@ -377,17 +379,13 @@ div.body p.centered {
377379

378380
div.sidebar > :last-child,
379381
aside.sidebar > :last-child,
380-
nav.contents > :last-child,
381-
aside.topic > :last-child,
382382
div.topic > :last-child,
383383
div.admonition > :last-child {
384384
margin-bottom: 0;
385385
}
386386

387387
div.sidebar::after,
388388
aside.sidebar::after,
389-
nav.contents::after,
390-
aside.topic::after,
391389
div.topic::after,
392390
div.admonition::after,
393391
blockquote::after {
@@ -430,6 +428,10 @@ table.docutils td, table.docutils th {
430428
border-bottom: 1px solid #aaa;
431429
}
432430

431+
table.footnote td, table.footnote th {
432+
border: 0 !important;
433+
}
434+
433435
th {
434436
text-align: left;
435437
padding-right: 5px;
@@ -506,63 +508,6 @@ table.hlist td {
506508
vertical-align: top;
507509
}
508510

509-
/* -- object description styles --------------------------------------------- */
510-
511-
.sig {
512-
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
513-
}
514-
515-
.sig-name, code.descname {
516-
background-color: transparent;
517-
font-weight: bold;
518-
}
519-
520-
.sig-name {
521-
font-size: 1.1em;
522-
}
523-
524-
code.descname {
525-
font-size: 1.2em;
526-
}
527-
528-
.sig-prename, code.descclassname {
529-
background-color: transparent;
530-
}
531-
532-
.optional {
533-
font-size: 1.3em;
534-
}
535-
536-
.sig-paren {
537-
font-size: larger;
538-
}
539-
540-
.sig-param.n {
541-
font-style: italic;
542-
}
543-
544-
/* C++ specific styling */
545-
546-
.sig-inline.c-texpr,
547-
.sig-inline.cpp-texpr {
548-
font-family: unset;
549-
}
550-
551-
.sig.c .k, .sig.c .kt,
552-
.sig.cpp .k, .sig.cpp .kt {
553-
color: #0033B3;
554-
}
555-
556-
.sig.c .m,
557-
.sig.cpp .m {
558-
color: #1750EB;
559-
}
560-
561-
.sig.c .s, .sig.c .sc,
562-
.sig.cpp .s, .sig.cpp .sc {
563-
color: #067D17;
564-
}
565-
566511

567512
/* -- other body styles ----------------------------------------------------- */
568513

@@ -613,26 +558,19 @@ ul.simple p {
613558
margin-bottom: 0;
614559
}
615560

616-
aside.footnote > span,
617-
div.citation > span {
561+
dl.footnote > dt,
562+
dl.citation > dt {
618563
float: left;
564+
margin-right: 0.5em;
619565
}
620-
aside.footnote > span:last-of-type,
621-
div.citation > span:last-of-type {
622-
padding-right: 0.5em;
623-
}
624-
aside.footnote > p {
625-
margin-left: 2em;
626-
}
627-
div.citation > p {
628-
margin-left: 4em;
629-
}
630-
aside.footnote > p:last-of-type,
631-
div.citation > p:last-of-type {
566+
567+
dl.footnote > dd,
568+
dl.citation > dd {
632569
margin-bottom: 0em;
633570
}
634-
aside.footnote > p:last-of-type:after,
635-
div.citation > p:last-of-type:after {
571+
572+
dl.footnote > dd:after,
573+
dl.citation > dd:after {
636574
content: "";
637575
clear: both;
638576
}
@@ -649,6 +587,10 @@ dl.field-list > dt {
649587
padding-right: 5px;
650588
}
651589

590+
dl.field-list > dt:after {
591+
content: ":";
592+
}
593+
652594
dl.field-list > dd {
653595
padding-left: 0.5em;
654596
margin-top: 0em;
@@ -674,16 +616,6 @@ dd {
674616
margin-left: 30px;
675617
}
676618

677-
.sig dd {
678-
margin-top: 0px;
679-
margin-bottom: 0px;
680-
}
681-
682-
.sig dl {
683-
margin-top: 0px;
684-
margin-bottom: 0px;
685-
}
686-
687619
dl > dd:last-child,
688620
dl > dd:last-child > :last-child {
689621
margin-bottom: 0;
@@ -702,6 +634,14 @@ dl.glossary dt {
702634
font-size: 1.1em;
703635
}
704636

637+
.optional {
638+
font-size: 1.3em;
639+
}
640+
641+
.sig-paren {
642+
font-size: larger;
643+
}
644+
705645
.versionmodified {
706646
font-style: italic;
707647
}
@@ -742,24 +682,15 @@ dl.glossary dt {
742682

743683
.classifier:before {
744684
font-style: normal;
745-
margin: 0 0.5em;
685+
margin: 0.5em;
746686
content: ":";
747-
display: inline-block;
748687
}
749688

750689
abbr, acronym {
751690
border-bottom: dotted 1px;
752691
cursor: help;
753692
}
754693

755-
.translated {
756-
background-color: rgba(207, 255, 207, 0.2)
757-
}
758-
759-
.untranslated {
760-
background-color: rgba(255, 207, 207, 0.2)
761-
}
762-
763694
/* -- code displays --------------------------------------------------------- */
764695

765696
pre {
@@ -776,7 +707,6 @@ span.pre {
776707
-ms-hyphens: none;
777708
-webkit-hyphens: none;
778709
hyphens: none;
779-
white-space: nowrap;
780710
}
781711

782712
div[class*="highlight-"] {
@@ -840,12 +770,8 @@ div.code-block-caption code {
840770

841771
table.highlighttable td.linenos,
842772
span.linenos,
843-
div.highlight span.gp { /* gp: Generic.Prompt */
844-
user-select: none;
845-
-webkit-user-select: text; /* Safari fallback only */
846-
-webkit-user-select: none; /* Chrome/Safari */
847-
-moz-user-select: none; /* Firefox */
848-
-ms-user-select: none; /* IE10+ */
773+
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
774+
user-select: none;
849775
}
850776

851777
div.code-block-caption span.caption-number {
@@ -860,6 +786,16 @@ div.literal-block-wrapper {
860786
margin: 1em 0;
861787
}
862788

789+
code.descname {
790+
background-color: transparent;
791+
font-weight: bold;
792+
font-size: 1.2em;
793+
}
794+
795+
code.descclassname {
796+
background-color: transparent;
797+
}
798+
863799
code.xref, a code {
864800
background-color: transparent;
865801
font-weight: bold;

0 commit comments

Comments
 (0)