Skip to main content

Petlja's command-line interface for learning content

Project description

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.

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-0.2.9.tar.gz (6.0 MB view details)

Uploaded Source

Built Distribution

petljadoc-0.2.9-py3-none-any.whl (6.1 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: petljadoc-0.2.9.tar.gz
  • Upload date:
  • Size: 6.0 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-0.2.9.tar.gz
Algorithm Hash digest
SHA256 5fd5fb63fcd639e384413fa9bae3cb4e59d77269e6edcf52e02c67d15e8ca81b
MD5 5fd8e81f56ccafd47209423c8e91cd12
BLAKE2b-256 23299dc5e5d1acf89b315e5226c0009ddbad4a21995bdad92b46357e7db6cea6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: petljadoc-0.2.9-py3-none-any.whl
  • Upload date:
  • Size: 6.1 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-0.2.9-py3-none-any.whl
Algorithm Hash digest
SHA256 651582ceb63dd0a2fdd0ae1d7adc7bfc5280ad67b358037d8991c4e7b246ef2f
MD5 f8c8a7b3d0d61eed4e6e9de4757afeed
BLAKE2b-256 919729c400ffadf128824e57145b975c8c1f1f34ec8f8ef70f16ae8fc802de4c

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