Refactor docs for API docs only (#704)

logicalclocks · Jul 7, 2022 · 13cfbd6 · 13cfbd6
1 parent 197d0bf
commit 13cfbd6
Show file tree

Hide file tree

Showing 7 changed files with 1,305 additions and 69 deletions.
diff --git a/.github/workflows/mkdocs-release.yml b/.github/workflows/mkdocs-release.yml
@@ -13,18 +13,20 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: set release version
+      - name: set major/minor/bugfix release version
         working-directory: ./java
         run: echo "RELEASE_VERSION=$(mvn org.apache.maven.plugins:maven-help-plugin:2.1.1:evaluate -Dexpression=project.version | grep -Ev 'Download|INFO|WARNING')" >> $GITHUB_ENV
 
+      - name: set major/minor release version
+        run: echo "MAJOR_VERSION=$(echo $RELEASE_VERSION | sed 's/^\([0-9]*\.[0-9]*\).*$/\1/')" >> $GITHUB_ENV
+
       - uses: actions/setup-python@v2
         with:
           python-version: '3.8'
-      - run: pip3 install pip==22.0.3
 
       - name: install deps
         working-directory: ./python
-        run: cp ../README.md . && pip3 install -e .[python,dev,docs]
+        run: cp ../README.md . && pip3 install pip==22.0.3 && pip3 install -e .[python,dev,docs]
 
       - name: generate autodoc
         run: python3 auto_doc.py
@@ -33,6 +35,5 @@ jobs:
         run: |
           git config --global user.name Mike
           git config --global user.email mike@docs.hopsworks.ai
-
       - name: mike deploy docs
-        run: mike deploy ${{ env.RELEASE_VERSION }} latest -u --push
+        run: mike deploy ${{ env.RELEASE_VERSION }} ${{ env.MAJOR_VERSION }} -u --push
diff --git a/docs/css/custom.css b/docs/css/custom.css
@@ -1,22 +1,61 @@
 :root {
   --md-primary-fg-color: #1EB382;
-  --md-secondary-fg-color: #35c495;
+  --md-secondary-fg-color: #188a64;
+  --md-tertiary-fg-color: #0d493550;
+  --md-quaternary-fg-color: #fdfdfd;
+  --border-radius-variable: 5px;
 }
 
-.md-logo {
-      margin: px2rem(4px);
-      padding: px2rem(8px);
+.md-footer__inner:not([hidden]) {
+  display: none
+}
+
+/* Lex did stuff here */
+.svg_topnav{
+  width: 12px;
+  filter: invert(100);
+}
+.svg_topnav:hover{
+  width: 12px;
+  filter: invert(10);
+}
+
+.md-header[data-md-state=shadow] {
+  box-shadow: 0 0 0 0;
+}
+
+.md-tabs__item:hover {
+  background-color: var(--md-tertiary-fg-color);
+  transition: background-color 450ms;
+
+}
+
+/*
+.md-sidebar__scrollwrap{
+  background-color: var(--md-quaternary-fg-color);
+  padding: 15px 5px 5px 5px;
+  border-radius: var(--border-radius-variable);
+}
+*/
+.md-nav__link:focus{
+}
+
+.image_logo_02{
+  width:450px;
+}
+
+/* End of Lex did stuff here */
 
-      // Image or icon
-      img {
-        width: px2rm(500px);
-},
-      svg {
-        display: block;
-        width: px2rem(500px);
-        height: px2rem(48px);
-        fill: currentColor;
+.md-header__button.md-logo {
+  margin: .1rem;
+  padding: .1rem;
 }
+
+.md-header__button.md-logo img, .md-header__button.md-logo svg {
+  display: block;
+  width: 1.8rem;
+  height: 1.8rem;
+  fill: currentColor;
 }
 
 .md-tabs {
@@ -26,3 +65,47 @@
   background-color: var(--md-secondary-fg-color);
   transition: background-color 250ms;
 }
+
+
+.wrapper {
+  display: grid;
+  grid-template-columns: repeat(4, 1fr);
+  gap: 10px;
+  grid-auto-rows: minmax(100px, auto);
+}
+
+.wrapper * {
+    border: 2px solid green;
+    text-align: center;
+    padding: 70px 0;
+}
+
+.one {
+  grid-column: 1 / 2;
+  grid-row: 1;
+}
+.two {
+  grid-column: 2 / 3;
+  grid-row: 1;
+}
+.three {
+  grid-column: 3 / 4;
+  grid-row: 1;
+}
+.four {
+  grid-column: 4 / 5;
+  grid-row: 1;
+}
+.five {
+  grid-column: 1 / 3;
+  grid-row: 2;
+}
+.six {
+  grid-column: 3 / 5;
+  grid-row: 2;
+}
+
+/* Jupyter Stuff */
+.jupyter-wrapper .jp-CodeCell .jp-Cell-inputWrapper .jp-InputPrompt {
+  display: none !important;
+}
diff --git a/docs/css/dropdown.css b/docs/css/dropdown.css
@@ -0,0 +1,55 @@
+/* Style The Dropdown Button */
+.dropbtn-api {
+  color: white;
+  border: none;
+  cursor: pointer;
+}
+
+.md-tabs__list {
+  contain: inherit;
+}
+.md-tabs {
+overflow: inherit;
+}
+.md-header {
+  z-index: 1000 !important;
+}
+
+/* The container <div> - needed to position the dropdown content */
+.dropdown-api {
+  position: relative;
+  display: inline-block;
+}
+
+/* Dropdown Content (Hidden by Default) */
+.dropdown-content-api {
+  display:none;
+  font-size: 13px;
+  position: absolute;
+  background-color: #f9f9f9;
+  min-width: 160px;
+  box-shadow: 0px 8px 16px 0px rgba(0,0,0,0.2);
+  z-index: 1000;
+  border-radius: 2px;
+  left:-15px;
+}
+
+/* Links inside the dropdown */
+.dropdown-content-api a {
+  color: black;
+  padding: 12px 16px;
+  text-decoration: none;
+  display: block;
+}
+
+/* Change color of dropdown links on hover */
+.dropdown-content-api a:hover {background-color: #f1f1f1}
+
+/* Show the dropdown menu on hover */
+.dropdown-api:hover .dropdown-content-api {
+  display: block;
+}
+
+/* Change the background color of the dropdown button when the dropdown content is shown */
+.dropdown-api:hover .dropbtn-api {
+}