Skip to content
Snippets Groups Projects

doc[README][RTD]: Refactor README from RST to MarkDown and add jupyter usage installation instructions.

Merged Karim Ahmed requested to merge doc/convert_README_from_rst_to_MD into master
1 unresolved thread

Description

  • Added jupyter notebook installation instructions (i.e. pip install notebook==5.6.1)
  • Moved README from RST to MarkDown for sanity.
  • Updated RTD instructions as well for the jupyter part.
  • Removed redundant instructions and collected the steps and bash code together.

How Has This Been Tested?

Relevant Documents (optional)

Types of changes

  • Docs (changes to the documentation)
  • Refactor (refactoring code with no functionality changes)
  • Style (formatting changes only, no code changes)

Checklist:

Reviewers

@roscar @kluyvert @rovensky

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Karim Ahmed added 1 commit

    added 1 commit

    • 72fe0589 - fix: write correct working jupyter version and improve copy/paste command windows

    Compare with previous version

  • Karim Ahmed resolved all threads

    resolved all threads

  • merged

  • Karim Ahmed mentioned in commit 71377cf5

    mentioned in commit 71377cf5

  • Philipp Schmidt changed milestone to %3.15.1

    changed milestone to %3.15.1

  • Please register or sign in to reply
    Loading