Skip to content

prevent sidebar from collapsing in api reference #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 1, 2021
Merged

prevent sidebar from collapsing in api reference #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
878badd
prevent sidebar from collapsing in api reference
Apr 1, 2021
6c86e5a
Merge branch 'develop' of https://github.com/Labelbox/labelbox-python…
Apr 1, 2021
5690c7a
yapf
Apr 1, 2021
2e502d3
update README
Apr 1, 2021
38123c3
never collapse
Apr 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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.
Expand All @@ -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`

Expand Down
13 changes: 13 additions & 0 deletions docs/source/_static/js/prevent_collapse.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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')
}
}
8 changes: 7 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
project = 'Labelbox Python API reference'
copyright = '2021, Labelbox'

release = '2.4'
release = '2.5.3'

# -- General configuration ---------------------------------------------------

Expand Down Expand Up @@ -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,
}
4 changes: 2 additions & 2 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) |