Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ jobs:
tests:

strategy:
fail-fast: false
matrix:
os: [ubuntu-latest]
python-version: [3.6, 3.7, 3.8]
Expand Down
12 changes: 8 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
"repository_branch": "master",
"use_edit_page_button": True,
"path_to_docs": "docs/",
"show_navbar_depth": 2,
}

intersphinx_mapping = {
Expand Down Expand Up @@ -96,10 +97,13 @@
execution_show_tb = "READTHEDOCS" in os.environ
execution_timeout = 60 # Note: 30 was timing out on RTD

myst_admonition_enable = True
myst_amsmath_enable = True
myst_html_img_enable = True
myst_deflist_enable = True
myst_enable_extensions = [
"amsmath",
"colon_fence",
"deflist",
"dollarmath",
"html_image",
]
myst_url_schemes = ("http", "https", "mailto")
panels_add_bootstrap_css = False

Expand Down
14 changes: 9 additions & 5 deletions docs/examples/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,13 @@ See the [MyST configuration options](myst:intro/config-options) for the full set
To build documentation from this notebook, the following options are set:

```python
myst_admonition_enable = True
myst_amsmath_enable = True
myst_html_img_enable = True
myst_enable_extensions = [
"amsmath",
"colon_fence",
"deflist",
"dollarmath",
"html_image",
]
myst_url_schemes = ("http", "https", "mailto")
```

Expand All @@ -47,7 +51,7 @@ For example, here's the MyST-NB logo:

![myst-nb logo](../_static/logo.png)

With the `myst_html_img_enable=True` ([see here](myst:syntax/images)), you can even add HTML img tags with attributes:
By adding `"html_image"` to the `myst_enable_extensions` list in the sphinx configuration ([see here](myst:syntax/images)), you can even add HTML `img` tags with attributes:

```html
<img src="../_static/logo.png" alt="logo" width="200px" class="shadow mb-2">
Expand All @@ -70,7 +74,7 @@ It was generated with this code ([as explained here](myst:syntax/admonitions)):

:::::

If you wish to use "bare" LaTeX equations, then you should set `myst_amsmath_enable = True` in the sphinx configuration.
If you wish to use "bare" LaTeX equations, then you should add `"amsmath"` to the `myst_enable_extensions` list in the sphinx configuration.
This is [explained here](myst:syntax/amsmath), and works as such:

```latex
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/custom-formats.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ nb_custom_formats = {
```

:::{important}
For full compatibility with `myst-nb`, `jupytext>=1.6.0` should be used.
For full compatibility with `myst-nb`, `jupytext>=1.8.0` should be used.
:::

For example:
Expand Down
2 changes: 1 addition & 1 deletion myst_nb/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = "0.10.1"
__version__ = "0.11.0"

from collections.abc import Sequence
import os
Expand Down
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
python_requires=">=3.6",
package_data={"myst_nb": ["_static/*"]},
install_requires=[
"myst-parser~=0.12.9",
"myst-parser~=0.13.1",
"docutils>=0.15",
"sphinx>=2,<4",
# TODO 0.3.2 requires some changes to the pytests
Expand All @@ -74,10 +74,10 @@
"numpy",
"sympy",
"pandas",
"jupytext>=1.6.0",
"jupytext~=1.8.0",
],
"rtd": [
"jupytext>=1.6.0",
"jupytext~=1.8.0",
"coconut~=1.4.3",
"sphinxcontrib-bibtex",
"ipywidgets",
Expand Down
Loading