Skip to content
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.

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

[READY] Add new notebook example to docs about adding Kedro to a notebook project #3128

Merged
merged 12 commits into from
Oct 11, 2023
Merged
10 changes: 10 additions & 0 deletions docs/examples/add_kedro_to_spaceflights_notebook/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# How to extract notebook content to markdown

To publish `add_kedro_to_a_notebook.ipynb` in the Kedro docs, follow these steps.

1. In your virtual environment: `pip install jupytext`
2. In the notebook folder: jupytext --set-formats ipynb,md <notebook_name>.ipynb

Check warning on line 6 in docs/examples/add_kedro_to_spaceflights_notebook/README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/examples/add_kedro_to_spaceflights_notebook/README.md#L6

[Kedro.Spellings] Did you really mean 'jupytext'?
Raw output
{"message": "[Kedro.Spellings] Did you really mean 'jupytext'?", "location": {"path": "docs/examples/add_kedro_to_spaceflights_notebook/README.md", "range": {"start": {"line": 6, "column": 28}}}, "severity": "WARNING"}
3. Move the resultant markdown to the appropriate docs folder


The two steps above create a markdown file with a copy of the contents of the notebook, and we may be able to automate this step as per https://jupytext.readthedocs.io/en/stable/config.html but it's beyond my level of knowledge.

Check notice on line 10 in docs/examples/add_kedro_to_spaceflights_notebook/README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/examples/add_kedro_to_spaceflights_notebook/README.md#L10

[Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.
Raw output
{"message": "[Kedro.sentencelength] Try to keep your sentence length to 30 words or fewer.", "location": {"path": "docs/examples/add_kedro_to_spaceflights_notebook/README.md", "range": {"start": {"line": 10, "column": 1}}}, "severity": "INFO"}

Check warning on line 10 in docs/examples/add_kedro_to_spaceflights_notebook/README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/examples/add_kedro_to_spaceflights_notebook/README.md#L10

[Kedro.pronouns] Avoid first-person singular pronouns such as 'my'.
Raw output
{"message": "[Kedro.pronouns] Avoid first-person singular pronouns such as 'my'.", "location": {"path": "docs/examples/add_kedro_to_spaceflights_notebook/README.md", "range": {"start": {"line": 10, "column": 207}}}, "severity": "WARNING"}
Loading
Loading