LIN-731 Migrate to MkDocs and Netlify (LineaLabs#873)

* Set up MkDocs

* Create minimal docs subset

* Refresh demos folder and update docs

* Create custom feedback form

* Improve feedback form

* Migrate tutorials

* Migrate installation and setup guide

* Remove unnecessary RST files

* Migrate contribution guide materials

* Migrate guide for code cleanup

* Migrate guide for troubleshooting and more help

* Improve navigation

* Migrate API reference for <lineapy.api.api> module

* Turn off sticky nav tabs

* Fix cross-reference between pages

* Migrate other contents under guides/usage/

* Migrate area-specific contribution guides

* Fix outdated links

* Migrate configuration guides

* Clean up unnecessary Sphinx docs

* Make stylistic improvements

* Add Netlify status badge to README

* Add guide for updating docs

* Reorg docs for leaner hosting on Netlify

* Fix outdated link syntax

* Update Netlify status badge

* Use site header to promote LineaPy Slack community

* Enhance site settings

* Use edit_uri to direct to correct edit page

* Automate generation of API reference pages

* Update instructions on updating API reference

* LIN-731: Updating the docstrings to match format expected by mkdocs

* Reformat docstrings in lineapy.api

* Reformat docstrings in lineapy.system_tracing

* Reformat docstrings in lineapy.transformer

* Reformat docstrings in lineapy.utils

* Minor fixes

- Fix warnings from MkDocs
- Restore "Tutorial" as section title
- Keep TODO messages internal (i.e., move out of docstring, which is user-facing)

* Update GH workflow to reflect new directory structure

* Skip unnecessary docstring test

* Reduce redundancy in dependency listing

* Use mike

* Remove page edit button (not useful for versioned docs)

* When getting user feedback, record corresponding docs version

* Skip certain modules in API reference build

* List mike as a dependency for docs

* Reorganize docs folder

* Set <latest> as "canonical" version to use for documentation (useful for SEO)

* Revert unsuccessful extraction of docs version

* Add instructions for publishing docs updates

* Add docs version warning

* Replace RTD links with (corresponding) Netlify ones

* Add an anchor link to each headline

* Refresh demos folder and update docs

* Fix mis-formatting

* Update links with the new custom domain

* Add more details to instructions for publishing docs updates

* Fix wrong path

* Update links to Colab notebooks

* For Colab, default to the notebook file name

* Move <lineapy_overview.png> from <01_using_artifacts.ipynb> to <00_lineapy_quickstart.ipynb>

* Refresh demos folder and update docs

* Update link to contributor guide

* Enable support for Mermaid.js diagraming

* Instrument Google analytics

* Update bitly links

* Refresh demos folder and update docs

* Comments pt1

* Comments pt2

* Comments 3

* Comments 4

* Remove last .rst files

* Fix links in notebooks

* Refresh demos folder and update docs

* Update makefile

* Comments again

* Refresh demos folder and update docs

Co-authored-by: Humble bot servant <infra@linea.ai>
Co-authored-by: Aayan Kumar <aayan.kumar@linea.ai>
Co-authored-by: Andrew Cui <andycui97@gmail.com>

.colab/00_lineapy_quickstart.ipynb

@@ -1,5 +1,13 @@
 {
     "cells": [
+        {
+            "cell_type": "markdown",
+            "id": "7dbd824a",
+            "metadata": {},
+            "source": [
+                "[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://bit.ly/3y5IiSq)"
+            ]
+        },
         {
             "cell_type": "markdown",
             "id": "84709142",
@@ -34,25 +42,35 @@
         },
         {
             "cell_type": "markdown",
-            "id": "9162ed7f",
+            "id": "12c5277f",
             "metadata": {},
             "source": [
-                "<div class=\"alert alert-info\">\n",
-                "\n",
-                "If you encounter issues you cannot resolve, simply ask in our [Slack community](https://join.slack.com/t/lineacommunity/shared_invite/zt-18kizfn3b-1Qu_HDT3ahGudnAwoFAw9Q)'s `#support` channel. We are always happy and ready to help you!\n",
-                "\n",
+                "![LineaPy_artifact](https://linea-docs-assets.s3.us-west-1.amazonaws.com/lineapy_overview.png)"
+            ]
+        },
+        {
+            "cell_type": "markdown",
+            "id": "b6a7f6ad",
+            "metadata": {},
+            "source": [
+                "<div class=\"admonition info\" style=\"background:#F0FAFA\">\n",
+                "    <p class=\"admonition-title\"><b>Info</b></p>\n",
+                "    <p>\n",
+                "        If you encounter issues you cannot resolve, simply ask in our <a href=\"https://join.slack.com/t/lineacommunity/shared_invite/zt-18kizfn3b-1Qu_HDT3ahGudnAwoFAw9Q\">Slack community</a>'s <code>#support</code> channel. We are always happy and ready to help you!\n",
+                "    </p>\n",
                 "</div>"
             ]
         },
         {
             "cell_type": "markdown",
-            "id": "75ec8c55",
+            "id": "6579be89",
             "metadata": {},
             "source": [
-                "<div class=\"alert alert-info\">\n",
-                "\n",
-                "You can ignore `# NBVAL_*` comments in certain cell blocks. They are for passing unit tests only, which we do to make sure the examples are always functional as we update the codebase.\n",
-                "\n",
+                "<div class=\"admonition note\" style=\"background:#F0F4FA\">\n",
+                "    <p class=\"admonition-title\"><b>Note</b></p>\n",
+                "    <p>\n",
+                "        You can ignore <code># NBVAL_*</code> comments in certain cell blocks. They are for passing unit tests only, which we do to make sure the examples are always functional as we update the codebase.\n",
+                "    </p>\n",
                 "</div>"
             ]
         },
@@ -85,13 +103,14 @@
         },
         {
             "cell_type": "markdown",
-            "id": "4afe5fcf",
+            "id": "56d35928",
             "metadata": {},
             "source": [
-                "<div class=\"alert alert-info\">\n",
-                "\n",
-                "For more information about installation, check this [page](https://docs.lineapy.org/en/main/guides/installation.html) in the project documentation.\n",
-                "\n",
+                "<div class=\"admonition info\" style=\"background:#F0FAFA\">\n",
+                "    <p class=\"admonition-title\"><b>Info</b></p>\n",
+                "    <p>\n",
+                "        For more information about installation, check this <a href=\"https://docs.lineapy.org/latest/guides/setup/\">page</a> in the project documentation.\n",
+                "    </p>\n",
                 "</div>"
             ]
         },
@@ -136,13 +155,14 @@
         },
         {
             "cell_type": "markdown",
-            "id": "8de0daaf",
+            "id": "02d07bd0",
             "metadata": {},
             "source": [
-                "<div class=\"alert alert-info\">\n",
-                "\n",
-                "For information about running LineaPy in different interfaces, check this [page](https://docs.lineapy.org/en/main/guides/interfaces.html) in the project documentation.\n",
-                "\n",
+                "<div class=\"admonition info\" style=\"background:#F0FAFA\">\n",
+                "    <p class=\"admonition-title\"><b>Info</b></p>\n",
+                "    <p>\n",
+                "        For information about running LineaPy in different interfaces, check this <a href=\"https://docs.lineapy.org/latest/guides/setup/#running-lineapy\">page</a> in the project documentation.\n",
+                "    </p>\n",
                 "</div>"
             ]
         },
@@ -230,7 +250,7 @@
             "id": "58bc93cd",
             "metadata": {},
             "source": [
-                "Let's say you're happy with your above code, and you've decided to save the trained model. You can store the model as a LineaPy [artifact](https://docs.lineapy.org/en/main/concepts/artifact.html) with the following code:"
+                "Let's say you're happy with your above code, and you've decided to save the trained model. You can store the model as a LineaPy [artifact](https://docs.lineapy.org/latest/concepts/artifact/) with the following code:"
             ]
         },
         {
@@ -312,13 +332,14 @@
         },
         {
             "cell_type": "markdown",
-            "id": "36e4e2b6",
+            "id": "fc22bb9c",
             "metadata": {},
             "source": [
-                "<div class=\"alert alert-info\">\n",
-                "\n",
-                "To learn more about LineaPy artifacts and how to work with them, check this [tutorial](https://docs.lineapy.org/en/main/tutorials/01_using_artifacts.html).\n",
-                "\n",
+                "<div class=\"admonition info\" style=\"background:#F0FAFA\">\n",
+                "    <p class=\"admonition-title\"><b>Info</b></p>\n",
+                "    <p>\n",
+                "        To learn more about LineaPy artifacts and how to work with them, check this <a href=\"https://docs.lineapy.org/latest/tutorials/01_using_artifacts/\">tutorial</a>.\n",
+                "    </p>\n",
                 "</div>"
             ]
         },
@@ -418,13 +439,14 @@
         },
         {
             "cell_type": "markdown",
-            "id": "4cc2f796",
+            "id": "5dd92dd0",
             "metadata": {},
             "source": [
-                "<div class=\"alert alert-info\">\n",
-                "\n",
-                "To learn more about LineaPy's pipeline support, check this [tutorial](https://docs.lineapy.org/en/main/tutorials/02_pipeline_building.html).\n",
-                "\n",
+                "<div class=\"admonition info\" style=\"background:#F0FAFA\">\n",
+                "    <p class=\"admonition-title\"><b>Info</b></p>\n",
+                "    <p>\n",
+                "        To learn more about LineaPy's pipeline support, check this <a href=\"https://docs.lineapy.org/latest/tutorials/02_pipeline_building/\">tutorial</a>.\n",
+                "    </p>\n",
                 "</div>"
             ]
         },
@@ -457,7 +479,7 @@
             "id": "811e1cab",
             "metadata": {},
             "source": [
-                "Excited? Continue to learn basic functionalities of LineaPy artifacts in this [tutorial](https://docs.lineapy.org/en/main/tutorials/01_using_artifacts.html)."
+                "Excited? Continue to learn basic functionalities of LineaPy artifacts in this [tutorial](https://docs.lineapy.org/latest/tutorials/01_using_artifacts/)."
             ]
         }
     ],