add custom launch buttons to jupyter-book
Project description
custom launch buttons v1
First version of custom launch buttons for jupyter-book (https://jupyterbook.org/en/stable/interactive/launchbuttons.html). Install using
pip install git+https://github.com/TeachBooks/Sphinx-launch-buttons.git
to use in a jupyter-book, first include the extension in the _config.yml file
sphinx:
extra_extensions:
- custom-launch-buttons
then include a _launch_buttons.yml file along the _config.yml file. Buttons can be defined as follows:
buttons:
- type: dropdown
icon: <svg> </svg>
items:
- label: item 1
url: https://linkone.com
- label: item 2
url: https://linktwo.com
- type: dropdown
label: languages
items:
- label: Dutch
url: https://www.dutch.com
- label: English
url: https://www.english.com
- label: French
url: https://www.french.com
where buttons is an array of launch buttons, each which can be identified using 'dropdown' or 'button'.
buttons:
- type : dropdown
- type : button
The button/dropdown can be visualised using either an svg icon (https://icons.getbootstrap.com/#icons) or text.
buttons:
- type : dropdown
label: Language
- type : button
label : <svg></svg>
Test icons using
icon: <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-translate" viewBox="0 0 16 16">
<path d="M4.545 6.714 4.11 8H3l1.862-5h1.284L8 8H6.833l-.435-1.286zm1.634-.736L5.5 3.956h-.049l-.679 2.022z"/>
<path d="M0 2a2 2 0 0 1 2-2h7a2 2 0 0 1 2 2v3h3a2 2 0 0 1 2 2v7a2 2 0 0 1-2 2H7a2 2 0 0 1-2-2v-3H2a2 2 0 0 1-2-2zm2-1a1 1 0 0 0-1 1v7a1 1 0 0 0 1 1h7a1 1 0 0 0 1-1V2a1 1 0 0 0-1-1zm7.138 9.995q.289.451.63.846c-.748.575-1.673 1.001-2.768 1.292.178.217.451.635.555.867 1.125-.359 2.08-.844 2.886-1.494.777.665 1.739 1.165 2.93 1.472.133-.254.414-.673.629-.89-1.125-.253-2.057-.694-2.82-1.284.681-.747 1.222-1.651 1.621-2.757H14V8h-3v1.047h.765c-.318.844-.74 1.546-1.272 2.13a6 6 0 0 1-.415-.492 2 2 0 0 1-.94.31"/>
</svg>
Then the same story goes for each of the items in the dropdown menu.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for custom-launch-buttons-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e797d3dea91481b35dced58678c8dee43cfa7de591ad3160126202f5c340ce4f |
|
MD5 | 508c5a9e43a96a04f4657a1b8975565a |
|
BLAKE2b-256 | 5226d1ba2c8aeae028644546b61f73bac28999c6eb4cf1b4c996d363d8bcab52 |
Hashes for custom_launch_buttons-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 49458068e755210bed71f726fe71613de4ca5c7b1b43a8d4d8e2dfca9b8e4d93 |
|
MD5 | 2cfbba48b40ed8e091f4b905215b6b37 |
|
BLAKE2b-256 | a60ee7d08152bdac138949e9aacf3e1aad1da0038df5610d30a89124ec570ddd |