Merge pull request #133 from Labelbox/ms/api-reference-theme

prevent sidebar from collapsing in api reference

Author: msokoloff1

README.md

@@ -8,8 +8,8 @@ The Labelbox Python API offers a simple, user-friendly way to interact with the
 
 * [Requirements](#requirements)
 * [Installation](#installation)
-* [Authentication](#authentication)
 * [Documentation](#documentation)
+* [Authentication](#authentication)
 * [Contribution](#contribution)
 * [Testing](#testing)
 
@@ -40,6 +40,12 @@ Install using Python's Pip manager.
 pip install labelbox
 ```
 
+## Documentation
+
+* [Visit our docs](https://labelbox.com/docs/python-api) to learn how the SDK works
+* Checkout our [notebook examples](examples/) to follow along with interactive tutorials
+* view our [API reference](https://labelbox.com/docs/python-api/api-reference).
+
 ## Authentication
 
 Labelbox uses API keys to validate requests. You can create and manage API keys on [Labelbox](https://app.labelbox.com/account/api-keys). Pass your API key as an environment variable. Then, import and initialize the API Client.
@@ -52,10 +58,6 @@ from labelbox import Client
 client = Client()
 ```
 
-## Documentation
-
-[Visit our docs](https://labelbox.com/docs/python-api) to learn how to [create a project](https://labelbox.com/docs/python-api/create-first-project), read through some helpful user guides, and view our [API reference](https://labelbox.com/docs/python-api/api-reference).
-
 ## Contribution
 Please consult `CONTRIB.md`
 

docs/source/_static/js/prevent_collapse.js

@@ -0,0 +1,13 @@
+
+window.addEventListener('load', (event) => {
+    var menu = document.querySelector(".wy-menu ul li:first-child")
+    if (!menu.classList.contains("current")) {
+        menu.classList.add("current")
+    }
+});
+
+window.onload = function() {
+    if (window.jQuery) {  
+        $(window).off('hashchange')
+    } 
+}

docs/source/conf.py

@@ -20,7 +20,7 @@
 project = 'Labelbox Python API reference'
 copyright = '2021, Labelbox'
 
-release = '2.4'
+release = '2.5.3'
 
 # -- General configuration ---------------------------------------------------
 
@@ -50,3 +50,9 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
+
+# Prevent the sidebar from collapsing
+html_js_files = ['js/prevent_collapse.js']
+html_theme_options = {
+    "collapse_navigation": False,
+}

examples/README.md

@@ -43,5 +43,5 @@
 | Notebook                    | Github                            | Google Colab |
 | --------------------------- | --------------------------------- | ------------ |
 | Project Setup  | [Github](project_configuration/project_setup.ipynb)               | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/project_configuration/project_setup.ipynb) | 
-| Debugging MAL                 | [Github](project_configuration/queue_management.ipynb)         | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/project_configuration/queue_management.ipynb) | 
-| MAL with Subclasses           | [Github](project_configuration/webhooks.ipynb)   | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/project_configuration/webhooks.ipynb) | 
+| Queue Management                 | [Github](project_configuration/queue_management.ipynb)         | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/project_configuration/queue_management.ipynb) | 
+| Webhooks           | [Github](project_configuration/webhooks.ipynb)   | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/project_configuration/webhooks.ipynb) |