Skip to main content

A sphinx theme for generate S6 presentation. #sphinxjp

Project description

S6 style presentation theme for Sphinx.

Features

  • provide s6 directive for s6 presentation slide control.
  • provide s6 theme to render presentation.

Setup

Make environment with pip:

$ pip install sphinxjp.themes.s6

Convert Usage

setup conf.py with:

extensions = ['sphinxjp.themes.s6']
html_theme = 's6'

and run:

$ make html

Writing s6 directives

Slide paging effect:

.. s6:: effect slide

ul elements move from (0,0) to (100,0) position in 5.0 secs:

.. s6:: actions

    ['ul', 'move', '5.0', [0,0],[100,0]]

Set HTML styles on target slide:

.. s6:: styles

    h2: {fontSize:'150%', textAlign:'center', margin:'30% auto'}

This example is a bit more complex:

.. s6:: styles

    'ul/li': {display:'none'}

.. s6:: actions

    ['ul/li[0]', 'fade in', '0.3'],
    ['ul/li[1]', 'fade in', '0.3'],
    ['ul/li[2]', 'fade in', '0.3'],

Requirements

  • Python 2.5, 2.6, 2.7, 3.1, 3.2, 3.3
  • Sphinx 1.2 or later is recommended.
  • Sphinx < 1.2 requires sphinxjp.themecore package.

Presentation Environments

  • Internet Explorer 8.0
  • Firefox 3.6.x
  • Chrome / Safari

License

Licensed under the MIT license . See the LICENSE file for specific terms.

AUTHORS

Sphinx template, css, packaging

  • Takayuki SHIMIZUKAWA <shimizukawa AT gmail.com> sphinx-users.jp

s6.js

    1. 2007 Cybozu Labs, Inc.

TODOS

Features

  • Documentation: English ver.
  • Documentation: Desgin customization, slide examples
  • Key customization easier
  • Design customization easier
  • Footer text customization
  • Easy writing animation setting by s6 directive.
  • Provide default settings: i.e. slide animation type.

Improve usability

  • hide iPhone’s address bar.
  • move page if location.href changed.
  • hide Top click area for show index page that cover page thumbnails.

Limitation

  • local javascript file can’t work at default Chrome setting.

Bugs

no bugs, maybe.

History

0.3.0 (2013/12/10)

  • support Python-3.1, 3.2, 3.3.
  • support Sphinx-1.2 theme plugin feature. sphinxjp.themecore is no longer needed (if you use Sphinx-1.1.3, you need sphinxjp.themecore).
  • fix: footer box size now follow slide size.
  • reduce navigation layer area. It is obstacle sometime.
  • add js include feature by using app.add_javascript().
  • remove s6 node for make text, latex, .. not html should work.
  • refactoring: Move JS code from .html to .js file.
  • change: All styles in s6.css provide .sphinx class.

0.2.0 (2012/7/4)

  • fix: missing OL/LI number.
  • add: link-target click guard.
  • add: iPhone/iPad swipe feature.
  • add: navigation layer for smartphone and mouse.
  • add: resize view-port when browser window size are changed.
  • add: page jump by url hash (#id)
  • remove: save and load last displaying page by cookie (please use url hash).

0.1.3 (2011/7/6)

  • fix: namespace package declaration missing, thank you togakushi!

0.1.2 (2011/2/18)

  • include example (docs directory) again.

0.1.1 (2011/2/12)

  • add sample output

0.1.0 (2011/2/6)

  • first release

Project details


Release history Release notifications

This version
History Node

0.3.0

History Node

0.2.0

History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinxjp.themes.s6-0.3.0.tar.gz (306.2 kB) Copy SHA256 hash SHA256 Source None Dec 9, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page