Skip to content

Commit

Permalink
➖ Replace 'recommonmark' from doc dependencies by 'myst_parser' for u…
Browse files Browse the repository at this point in the history
…sing reStructuredText in markdown (#6)
  • Loading branch information
Galileo-Galilei committed May 2, 2022
1 parent 3e109b1 commit 5ad1f4e
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 15 deletions.
9 changes: 1 addition & 8 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@
# sys.path.insert(0, os.path.abspath('.'))


from recommonmark.transform import AutoStructify

# -- Project information -----------------------------------------------------
from kedro_mlflow import __version__ as km_version

Expand Down Expand Up @@ -46,7 +44,6 @@
# "sphinx.ext.ifconfig",
# "sphinx.ext.viewcode",
# "nbsphinx",
"recommonmark",
"sphinx_copybutton",
"sphinx_markdown_tables",
]
Expand Down Expand Up @@ -91,8 +88,4 @@
# see https://stackoverflow.com/questions/36925871/toctree-nested-drop-down:
html_theme_options = {"collapse_navigation": False}


def setup(app):
# enable rendering RST tables in Markdown
app.add_config_value("recommonmark_config", {"enable_eval_rst": True}, True)
app.add_transform(AutoStructify)
myst_heading_anchors = 5
4 changes: 2 additions & 2 deletions docs/source/01_introduction/02_motivation.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,6 @@ Above implementations have the advantage of being very straightforward and *mlfl

`kedro-mlflow` does not currently provide interface to set tags outside a Kedro ``Pipeline``. Some of above decisions are subject to debate and design decisions (for instance, metrics are often updated in a loop during each epoch / training iteration and it does not always make sense to register the metric between computation steps, e.g. as a an I/O operation after a node run).

```eval_rst
.. note:: You do **not** need any ``MLProject`` file to use mlflow inside your Kedro project. As seen in the [introduction](./01_introduction.md), this file overlaps with Kedro configuration files.
```{note}
You do **not** need any ``MLProject`` file to use mlflow inside your Kedro project. As seen in the [introduction](./01_introduction.md), this file overlaps with Kedro configuration files.
```
4 changes: 2 additions & 2 deletions docs/source/04_experimentation_tracking/05_version_metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ with mlflow.start_run():
) # create a "my_metric=0.3" value in the "metric" field in mlflow UI
```

```eval_rst
.. important Unlike mlflow default behaviour, if there is no active run, no run is created.
```{warning}
Unlike mlflow default behaviour, if there is no active run, no run is created.
```

- You can also specify a ``run_id`` instead of logging in the active run:
Expand Down
4 changes: 2 additions & 2 deletions docs/source/06_interactive_use/01_notebook_use.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# How to use `kedro-mlflow` in a notebook

```eval_rst
.. important:: You need to call ``pip install kedro_mlflow[extras]`` to access notebook functionalities.
```{important}
You need to call ``pip install kedro_mlflow[extras]`` to access notebook functionalities.
```

## Reminder on mlflow's limitations with interactive use
Expand Down
1 change: 0 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ def _parse_requirements(path, encoding="utf-8"):
extras_require={
"doc": [
"sphinx>=4.5.0,<5.0.0",
"recommonmark==0.7.1",
"sphinx_rtd_theme==1.0.0",
"sphinx-markdown-tables==0.0.15",
"sphinx-click==3.1.0",
Expand Down

0 comments on commit 5ad1f4e

Please sign in to comment.