sphinxcontrib-twine

Add some interactive stories (Twine) in your Sphinx docs.

Features

• Story formats: Chapbook, Harlowe, Snowman, SugarCube

• Contains multiple Twine stories in one page

• All format.js files are imported from twinejs and cdn.jsdelivr.net

Use

$ pip install sphinxcontrib-twine

extensions = [
    ...,
    'sphinxcontrib.twine'
]

.. twine::
    :format: Chapbook
    :title: Test
    :width: 100%
    :height: 500

    :: StoryTitle
    Test in Chapbook

    :: Start
    Start

License

Table of Contents

• 1. Usage
  • 1.1. Configure
  • 1.2. Directive
• 2. Examples
  • 2.1. Chapbook
  • 2.2. Harlowe
  • 2.3. Snowman
  • 2.4. SugarCube
• 3. Changelog
  • 3.1. 0.3.2
  • 3.2. 0.2.0
  • 3.3. 0.1.0