https://github.com/hhatto/sphinxcontrib-gruffygen

render Graph Extension for Sphinx
https://github.com/hhatto/sphinxcontrib-gruffygen

Last synced: 29 days ago
JSON representation

render Graph Extension for Sphinx

• Host: GitHub
• URL: https://github.com/hhatto/sphinxcontrib-gruffygen
• Owner: hhatto
• License: bsd-3-clause
• Created: 2010-10-06T03:14:40.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2012-10-03T17:32:53.000Z (about 12 years ago)
• Last Synced: 2024-10-14T11:09:03.551Z (2 months ago)
• Language: Python
• Homepage:
• Size: 102 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
What's This

===========

This is Graphing extension for Sphinx_ .

This extension adds the ``gruffy`` directive that automatically render graph.

using Gruffy_ module.

.. _Sphinx: http://sphinx.pocoo.org/

.. _Gruffy: http://pypi.python.org/pypi/gruffy/

Install

=======

used to easy_install::

  $ easy_install sphinxcontrib-gruffygen

Require

=======

Require Sphinx_ and Gruffy_

install::

    $ easy_install sphinx

    $ easy_install gruffy

Usage

=====

basic usage in sphinx documentation::

    .. gruffy::

       :type: SideBar

       :title: test graph

       :width: 500

        data("foo", [1, 4, 3])

        data("bar", [8, 2, 5])

set to following types,

* Area

* Bar

* Dot

* Line

* Pie

* SideBar

* StackedArea

* StackedBar

* StackedSideBar