sphinxjp.shibukawa extension README¶
This is a sphinx extension which render calendar by using Google Chart .
source:
.. schedule::
item1: 10/1 - 10/3
item2: 10/4 - 10/6
item3: 10/5 - 10/7
rendered:
Who’s shibukawa?¶
Yoshiki Shibukawa (@shibukawa) is great Sphinx evangelist in Japan. This module is one of gifts for his birthday (11/14)!
Setting¶
You can see available package at PyPI.
You can get source code at http://bitbucket.org/tk0miya/
Install¶
$ easy_install sphinxjp.shibukawa
Configure Sphinx¶
To enable this extension, add sphinxjp.shibukawa module to extensions option at conf.py.
# Enabled extensions
extensions = ['sphinxjp.shibukawa']
Directive¶
- .. schedule::
This directive insert a calendar into the generated document. schedule directive takes code block as source script.
Examples:
.. schedule:: item1: 10/1 - 10/3 item2: 10/4 - 10/6 item3: 10/5 - 10/7
You can change interval of date labels using interval option.
Examples:
.. schedule:: :interval: 2 item1: 10/1 - 10/3 item2: 10/4 - 10/6 item3: 10/5 - 10/7
