Merge 1ac7b70 into 930b2dc

convexengineering · Oct 14, 2021 · 9c0851c · 9c0851c
2 parents 930b2dc + 1ac7b70
commit 9c0851c
Show file tree

Hide file tree

Showing 58 changed files with 1,210 additions and 939 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1,4 @@
+include docs/source/*.rst
+include docs/source/examples/*.txt
+include docs/source/examples/*.py
+include gpfit/tests/artifacts/*.txt
diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
-<img src="http://gpfit.readthedocs.io/en/latest/_images/GPfit_logo.png" width=110 alt="GPfit" />
+# GPfit
 
 **[Documentation](http://gpfit.readthedocs.org/)** | [Examples](http://gpfit.readthedocs.org/en/latest/examples.html) |
 
 GPfit is a Python package for fitting geometric programming models to data.
-This [paper](https://convex.mit.edu/publications/gpfitting.pdf) describes the
-approach.
+This [paper](https://dspace.mit.edu/bitstream/handle/1721.1/105753/11081_2016_9332_ReferencePDF.pdf?sequence=2&isAllowed=y) describes the approach.
 GPfit requires installation of [GPkit](http://gpkit.readthedocs.org/en/latest/).
 
-[![Build Status](https://acdl.mit.edu/csi/buildStatus/icon?job=CE_gpfit_Push)](https://acdl.mit.edu/csi/job/CE_gpfit_Push/)
+[![Build Status](https://acdl.mit.edu/csi/buildStatus/icon?job=CE_gpfit_Push_unit_tests)](https://acdl.mit.edu/csi/view/convex%20engineering/job/CE_gpfit_Push_unit_tests/)
+[![Build Status](https://acdl.mit.edu/csi/buildStatus/icon?job=CE_gpfit_Push_pylint)](https://acdl.mit.edu/csi/view/convex%20engineering/job/CE_gpfit_Push_pylint/)
diff --git a/docs/source/GPfit_logo.eps b/docs/source/GPfit_logo.eps
diff --git a/docs/source/GPfit_logo.png b/docs/source/GPfit_logo.png
diff --git a/docs/source/GPfit_logo.svg b/docs/source/GPfit_logo.svg
diff --git a/docs/source/_static/css/custom.css b/docs/source/_static/css/custom.css
@@ -0,0 +1,68 @@
+@import url('https://fonts.googleapis.com/css2?family=Raleway:ital,wght@0,300;0,400;0,600;1,300;1,400;1,600&display=swap');
+
+:root {
+    --sidebarcolor: #102133;
+    --sidebarfontcolor: #ffffff;
+	--sidebarhover: #295e97;
+
+    --bodyfontcolor: #333;
+	--webfont: 'Raleway';
+
+	--contentwidth: 1000px;
+}
+
+/* Fonts and text */
+h1, h2, h3, h4, h5, h6 {
+	font-family: var(--webfont), 'Helvetica Neue', Helvetica, Arial, sans-serif;
+	font-weight: 400;
+}
+
+h2, h3, h4, h5, h6 {
+  padding-top: 0.25em;
+  margin-bottom: 0.5em;
+}
+
+h1 {
+	font-size: 225%;
+}
+
+body {
+	font-family: var(--webfont), 'Helvetica Neue', Helvetica, Arial, sans-serif;
+	color: var(--bodyfontcolor);
+}
+
+p {
+	font-size: 1em;
+	line-height: 150%;
+}
+
+
+/* Sidebar */
+.wy-side-nav-search {
+    background-color: var(--sidebarcolor);
+}
+
+.wy-nav-side {
+    background: var(--sidebarcolor);
+}
+
+.wy-menu-vertical header, .wy-menu-vertical p.caption {
+    color: var(--sidebarfontcolor);
+}
+
+.wy-menu-vertical a {
+    color: var(--sidebarfontcolor);
+}
+
+.wy-side-nav-search > div.version {
+    color: var(--sidebarfontcolor);
+}
+
+.wy-menu-vertical a:hover {
+    background-color: var(--sidebarhover);
+}
+
+/* Main content */
+.wy-nav-content {
+    max-width: var(--contentwidth);
+}
diff --git a/docs/source/acknowledgements.rst b/docs/source/acknowledgements.rst
@@ -0,0 +1,9 @@
+Acknowledgements
+****************
+
+We thank the following people for helping to improve GPfit:
+
+* Marshall Galbraith for setting up continuous integration
+* `Akshay Agrawal`_ for the pretty docs css
+
+.. _`Akshay Agrawal`: https://www.akshayagrawal.com