Skip to main content

Petlja's command-line interface for learning content

Project description

PetljaDoc - Petlja's tool for eLearning content

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 the project 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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

petljadoc-1.1.10.tar.gz (8.3 MB view details)

Uploaded Source

Built Distribution

petljadoc-1.1.10-py3-none-any.whl (11.5 MB view details)

Uploaded Python 3

File details

Details for the file petljadoc-1.1.10.tar.gz.

File metadata

  • Download URL: petljadoc-1.1.10.tar.gz
  • Upload date:
  • Size: 8.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for petljadoc-1.1.10.tar.gz
Algorithm Hash digest
SHA256 675e0b8b5822c9b8447cb16995012e34532bdfc7ce73db04336f4da7bfe8d941
MD5 6ab0de398eb1e315e2fd16519d363267
BLAKE2b-256 f7520cbbccde5b6d4d5e0ba4a877dd6385e1653efd7a744d9b3ffa410b0442e3

See more details on using hashes here.

File details

Details for the file petljadoc-1.1.10-py3-none-any.whl.

File metadata

  • Download URL: petljadoc-1.1.10-py3-none-any.whl
  • Upload date:
  • Size: 11.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for petljadoc-1.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 ae4ef47cee597d2cd85ef998fe272406f8a8b716e8ec7674541a91d19715a4d5
MD5 df968024784af338c09b1d26c10d2647
BLAKE2b-256 4fcc43f8a1653d6548a2be076ae2ad96490728c69d1145f1f7089659768dfd42

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page