petljadoc 0.2.21

Petlja's command-line interface for learning content

PetljaDoc - Petlja's tool for interactive books

The tool is based on https://github.com/RunestoneInteractive/RunestoneComponents and https://github.com/sphinx-doc/sphinx and includes:

• additional Sphinx extensions
• partial Pygame implementation for Sculpt (https://github.com/Petlja/pygame4skulpt)
• additional ActiveCode features
• customized Sphinx theme
• customized project template
• exteded online course format
• petljadoc command line interface (CLI)

PetljaDoc currently depends on forked RunestoneComonents, but we are gradually closing the gap with the upstream repository through pull requests.

Installation

Use pip to install PetljaDoc:

pip3 install petljadoc

If you use Windows and previous command does not work, try:

py -3 -m pip install petljadoc

CLI usage

petljadoc [OPTIONS] COMMAND [ARGS]...

Options:

• --help    Show help message

Commands:

• init-course    Create a new online course project in your current directory
• init-runestone    Create a new Runestone project in your current directory
• preview    Build the project, open it in a web browser, watch for changes, rebuild changed files and refresh browser after rebuild (using sphinx-autobuild)
• publish    Build a Runestone project (like runestone build --all) and copy produced content in docs subfolder (ready to be published using GitHub Pages)

By using petljadoc preview, an author may keep opened a browser window for preview. Any saved changes will be updated in browser in about 5-10 seconds.

petljadoc publish command helps an author to share a public preview of his work via GitHub Pages.