Skip to content

A companion repository to the "You Only Write Thrice: Creating Documents, Computational Notebooks and Presentations From a Single Source" paper published at Rethinking ML Papers – ICLR 2021 Workshop.

License

So-Cool/you-only-write-thrice

Repository files navigation

Licence Online

You Only Write Thrice

This repository holds the source of an exhibit accompanying the "You Only Write Thrice" paper published at Rethinking ML Papers -- ICLR 2021 Workshop. The built book is hosted on GitHub Pages and is available under https://so-cool.github.io/you-only-write-thrice/. The online document is accompanied by reveal.js slides composed from a Markdown Notebook that is also a source document underlying a section of the online article. A static snapshot of the slides is built with the jupyter nbconvert conversion tool -- see the build_slides.sh script for more details. The slides can also be launched with RISE -- from a Jupyter Notebook through MyBinder -- to allow interactive and executable content. Therefore, in our workflow a single source file may produce:

  • computational notebooks;
  • static and interactive slides; and
  • sections of an online document/book.

Building the Book

  1. Pull the book repository
    git clone https://github.com/so-cool/you-only-write-thrice.git
    
    cd you-only-write-thrice
  2. Install Jupyter Book (requirements-article.txt) and slides execution requirements (requirements-slides.txt)
    pip install -r requirements-article.txt
    pip install -r requirements-slides.txt
  3. Build the book
    jb build .
  4. Build the slides
    ./build_slides.sh
  5. Open the html build
    open _build/html/index.html
    or run it as a server (to get the embedded SlidesLive window to work)
    python -m http.server --directory _build/html
    open http://localhost:8000

About

A companion repository to the "You Only Write Thrice: Creating Documents, Computational Notebooks and Presentations From a Single Source" paper published at Rethinking ML Papers – ICLR 2021 Workshop.

Topics

Resources

License

Stars

Watchers

Forks