Skip to content
Snippets Groups Projects
Commit 13e58149 authored by Chris Holdgraf's avatar Chris Holdgraf
Browse files

Update docs

parent 160db33c
No related branches found
No related tags found
No related merge requests found
......@@ -23,7 +23,7 @@ html_logo = 'images/logo-wide.svg'
html_sourcelink_suffix = ''
html_static_path = ['_static']
html_theme = 'sphinx_book_theme'
html_theme_options = {'search_bar_text': 'Search this book...', 'launch_buttons': {'notebook_interface': 'classic', 'binderhub_url': 'https://mybinder.org', 'jupyterhub_url': '', 'thebe': True, 'colab_url': 'https://colab.research.google.com'}, 'path_to_docs': 'docs', 'repository_url': 'https://github.com/executablebooks/jupyter-book', 'repository_branch': 'master', 'google_analytics_id': 'UA-52617120-7', 'extra_navbar': 'Powered by <a href="https://jupyterbook.org">Jupyter Book</a>', 'extra_footer': '', 'home_page_in_toc': False, 'use_repository_button': True, 'use_edit_page_button': True, 'use_issues_button': True}
html_theme_options = {'search_bar_text': 'Search this book...', 'launch_buttons': {'notebook_interface': 'classic', 'binderhub_url': 'https://mybinder.org', 'jupyterhub_url': '', 'thebe': True, 'colab_url': 'https://colab.research.google.com'}, 'path_to_docs': 'docs', 'repository_url': 'https://github.com/executablebooks/jupyter-book', 'repository_branch': 'master', 'google_analytics_id': 'UA-52617120-7', 'extra_navbar': 'Powered by <a href="https://jupyterbook.org">Jupyter Book</a>', 'extra_footer': '', 'home_page_in_toc': False, 'announcement': '⚠️The latest release refactored our HTML, so double-check your custom CSS rules!⚠️', 'use_repository_button': True, 'use_edit_page_button': True, 'use_issues_button': True}
html_title = ''
intersphinx_mapping = {'ebp': ['https://executablebooks.org/en/latest/', None], 'myst-parser': ['https://myst-parser.readthedocs.io/en/latest/', None], 'myst-nb': ['https://myst-nb.readthedocs.io/en/latest/', None], 'sphinx': ['https://www.sphinx-doc.org/en/master', None], 'nbformat': ['https://nbformat.readthedocs.io/en/latest', None], 'sphinx-panels': ['https://sphinx-panels.readthedocs.io/en/sphinx-book-theme/', None]}
jupyter_cache = ''
......
......@@ -4,25 +4,17 @@ You can provide text that is shown in an "announcement" banner.
The banner will disappear once the user scrolls down, but is styled with contrastive colors to be more noticeable.
This can be used to draw attention to certain messages but in a way that doesn't distract from reading as the person scrolls down.
To add an announcement message to your documentation, use the following configuration:
```{code-block} yaml
:caption: _config.yml
To add an announcement message to your documentation, use the following configuration in `_config.yml`:
```yaml
html:
...
announcement: "My announcement!",
...
announcement: "My announcement!"
```
The value of `announcement` will be inserted in the top of your page.
This can take arbitrary HTML, for example:
```{code-block} yaml
:caption: _config.yml
```yaml
html:
...
announcement: "<p class='mystyle'>Some custom HTML!</p>",
...
announcement: "<p class='mystyle'>Some custom HTML!</p>"
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment