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

Fix tutorial and jupyter docs #3850

Merged
merged 29 commits into from Jul 12, 2019
Merged

Fix tutorial and jupyter docs #3850

merged 29 commits into from Jul 12, 2019

Conversation

amn41
Copy link
Contributor

@amn41 amn41 commented Jun 23, 2019

Proposed changes:

Status (please check what you already did):

  • made PR ready for code review
  • added some tests for the functionality
  • updated the documentation
  • updated the changelog
  • reformat files using black (please check Readme for instructions)

@amn41 amn41 requested a review from erohmensing June 23, 2019 15:59
@erohmensing
Copy link
Contributor

Looks like it is failing because of these warnings:

/Users/erohmensing/rasa/docs/api/jupyter-notebooks.rst:30: WARNING: Error in "runnable" directive:
unknown option: "language".

.. runnable::
   :language: python

   config = "config.yml"
   training_files = "data/"
   domain = "domain.yml"
   output = "models/"
   print(config, training_files, domain, output)

as well as this one:

/Users/erohmensing/rasa/docs/api/jupyter-notebooks.rst:69: WARNING: Error in "runnable" directive:
invalid option block.

.. runnable::
   :language: python
   from rasa.jupyter import chat
   chat(model_path)

@erohmensing
Copy link
Contributor

Sorry, i tried to fix it myself without understanding that you're working on fixing it in the rasabaster repo i believe 😅feel free to revert my changes

Copy link
Contributor

@erohmensing erohmensing left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! The only thing I would think about adding is a note saying that if they want to run the code in their own notebook, not to copy the python in the code (since jupyter is a good platform for beginners)

@erohmensing erohmensing self-requested a review June 26, 2019 16:53
@erohmensing
Copy link
Contributor

Nevermind, this shouldn't be merged yet, the code still isn't working. Will fix

@erohmensing erohmensing changed the title Fix kernel jupyter docs Fix kernel jupyter docs [WIP] Jul 7, 2019
@erohmensing erohmensing changed the title Fix kernel jupyter docs [WIP] Fix tutorial kernel Jul 9, 2019
@erohmensing
Copy link
Contributor

@amn41 I’ve figured out how to fix the kernel code for jupyter notebooks (rasabaster PR review request incoming), but there are still other fixes (even to rasa) that need to go in to make it work. I propose that we send out this PR to fix the tutorial for 0.7.21 and temporarily hide the jupyter docs till they work again on rasabaster 0.7.22 and updated docs-binder requirements.

I’m tracking the jupyter stuff here: https://github.com/RasaHQ/customers/issues/128

Sound good?

@erohmensing erohmensing removed their request for review July 9, 2019 06:38
@erohmensing erohmensing changed the title Fix tutorial kernel Fix tutorial and jupyter docs Jul 12, 2019
@erohmensing erohmensing merged commit 16409ce into master Jul 12, 2019
@erohmensing erohmensing deleted the fix-kernel-jupyter-docs branch July 12, 2019 08:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants