Metadata-Version: 2.1
Name: petljadoc
Version: 1.1.8
Summary: Petlja's command-line interface for learning content
Home-page: https://github.com/Petlja/PetljaDoc
Author: Fondacija Petlja
Author-email: team@petlja.org
License: UNKNOWN
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`&nbsp;&nbsp;&nbsp;&nbsp;Show help message 
        
        Commands:
          - `init-course`&nbsp;&nbsp;&nbsp;&nbsp;Create a new online course project in your current directory
          - `init-runestone`&nbsp;&nbsp;&nbsp;&nbsp;Create a new Runestone project in your current directory
          - `preview`&nbsp;&nbsp;&nbsp;&nbsp;Build the project, open it in a web browser, watch for changes, rebuild changed files and refresh browser after rebuild (using [sphinx-autobuild](https://github.com/GaretJax/sphinx-autobuild))
          - `publish`&nbsp;&nbsp;&nbsp;&nbsp;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.
        
        
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Education
Classifier: Topic :: Text Processing :: Markup
Requires-Python: >=3.7
Description-Content-Type: text/markdown
