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
petljadoccommand line interface (CLI)
PetljaDoc currenty depends on forked RunestoneComonents, but we are gradually closing the gap with the upstream repository through pull requests.
pip3 install https://github.com/Petlja/PetljaDoc/archive/master.zip
If you use Windows and previous command does not work, try:
py -3 -m pip install https://github.com/Petlja/PetljaDoc/archive/master.zip
petljadoc [OPTIONS] COMMAND [ARGS]...
--helpShow help message
init-runestoneCreate a new Runestone project in your current directory
previewBuild a Runstone projec (like
runestone build --all), open it in browser, watch for changes, rebuild changed files and refresh browser after rebuild (using sphinx-autobuild)
publishBuild a Runestone project (like
runestone build --all) and copy produced content in
docssubfolder (ready to be published using GitHub Pages)
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.