Git Product home page Git Product logo

notebooks's Introduction

notebooks

Runhouse example notebooks.

Syncing docs to run-house/runhouse

  1. Create new or update existing .ipynb notebook file, and put it in the proper subdirectory folder.

  2. Generate the .rst (docs) or .py (examples) file used for docs generation using the convert_nb.py script. The script will automatically put the rst file in the corresponding folder in the runhouse repo, so you will need to have run-house/runhouse cloned down as well.

    From the notebooks git root:

    python convert_nb.py \
        --files <path_to_ipynb> \
        --rh-repo <path_to_local_rh_git_folder> \
        --format <rst or python>
    

    The --files arg can take in multiple file paths, or if left empty, will perform the conversion for all notebooks in the repo.

  3. Create two PRs:

    • notebooks repo: Add and commit the updated .ipynb file.
    • runhouse repo: Add and commit the generated .rst or .py file.

    Make sure that any PR changes and updates are synced between the two repos.

notebooks's People

Contributors

carolineechen avatar mkandler avatar rohinb2 avatar dongreenberg avatar

Stargazers

Shahrzad Mahro avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.