Sphinx html builder capable of multiple build targets (scorm, moodle backup, static website).
Project description
Petlja Builder for Sphinx
This custom Sphinx builder, named PLCTBuilder
, extends the functionality of the StandaloneHTMLBuilder
to meet specific requirements for packaging content into various formats, such as bare HTML, Moodle backup, or SCORM.
Key Features
Bare HTML Content
The builder provides the ability to generate HTML content suitable for hosting as standalone pages
Moodle Backup
The builder supports packaging content in a format suitable for Moodle. Key features include:
SCORM
The builder facilitates the creation of SCORM-compliant packages. Noteworthy features include:
Usage
Bare HTML Content
# conf.py
# Import the Petlja Builder extension
extensions = ['plct-bulder-for-sphinx.builder.plct_builder']
To generate content, use the following command:
sphinx-build -b plct_builder source output
Configuration
Customize the behavior of the builder by updating the Sphinx configuration:
# conf.py
# Set the content URI
content_uri = 'your_content_uri'
# Specify additional build targets (e.g., 'moodle', 'scorm')
additional_build_targets = ['moodle', 'scorm']
License
This custom Sphinx builder is licensed under the MIT License. Feel free to adapt and extend it based on your specific requirements.
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
Built Distribution
File details
Details for the file plct_bulder_for_sphinx-0.0.1.tar.gz
.
File metadata
- Download URL: plct_bulder_for_sphinx-0.0.1.tar.gz
- Upload date:
- Size: 102.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3eb5d2c5d827b6f1aaa4c8382e4ce25547bcc4331c77481053eb15a50cf2a48d |
|
MD5 | 16872b6c71c4815cf6293c2b8b722aad |
|
BLAKE2b-256 | ec2137770fde1e480ce91549d1c64b2ff39941b3e4b97fa6e49e1346a38de9bb |
File details
Details for the file plct_bulder_for_sphinx-0.0.1-py3-none-any.whl
.
File metadata
- Download URL: plct_bulder_for_sphinx-0.0.1-py3-none-any.whl
- Upload date:
- Size: 116.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa373aaf88cf1bd6fbfda5308bcd3205bd979c53aba97c4362b8c08754a2528f |
|
MD5 | 9b9d32dc9859bbbbf26a92d769d1b62c |
|
BLAKE2b-256 | b080cfd6f5c07572cc5618a1945ce454b254875454cb69a5c0cd11d1c4e87844 |