Browse Source

Update documentation

pull/36/head
Florian Mounier 12 years ago
parent
commit
c74a5875cc
  1. 13
      configuration.yaml
  2. 29
      pages/contribute.rst
  3. 8
      pages/download.rst
  4. 40
      pages/metadata.rst
  5. 2
      pages/other_customizations.rst
  6. 18
      pages/support.rst
  7. 33
      static/css/style.css

13
configuration.yaml

@ -7,11 +7,14 @@ url: http://www.pygal.org/
menu:
- Documentation:
link: /documentation/
- Contribute:
link: /contribute/
- Support:
link: /support/
- Download:
link: /download/
ribbon:
url: http://github.com/Kozea/pygal
project (git):
url: git://github.com/Kozea/pygal.git
path: pygal
@ -23,9 +26,9 @@ vcs (git):
code browser (github):
project name: Kozea/pygal
bug tracker (redmine):
base url: http://redmine.kozea.fr/
project name: pygal
bug tracker (github):
base url: http://github.com/Kozea/pygal/issues
project name: Kozea/pygal
continuous integration (jenkins):
base url: http://jenkins.kozea.org/

29
pages/contribute.rst

@ -1,29 +0,0 @@
============
Contribute
============
As a Lazy Person
================
Want to write kind words? Please contact florian.mounier@kozea.fr.
As a Jabberer
=============
Want to say something? Join our Jabber room: pygal@room.jabber.kozea.fr.
As a Simple User
================
Found a bug? Want a new feature? Report a new issue on the `pygal
bug-tracker <http://redmine.kozea.fr/projects/pygal>`_ (registration
needed).
As a Hacker
===========
Interested in hacking? Feel free to clone the :codelink:`git repository on
GitHub` if you want to add new features, fix bugs or update documentation.

8
pages/download.rst

@ -14,17 +14,15 @@ Git Repository
==============
If you want the development version of pygal, take a look at the
:codelink:`git repository on GitHub`, or clone it thanks to::
:codelink:`git repository on GitHub`, or clone it with::
git clone git://github.com/Kozea/pygal.git
You can also download `the pygal package of the git repository
<https://github.com/Kozea/pygal/tarball/master>`_.
You can also download `the development snapshot from github <http://github.com/Kozea/pygal/tarball/master>`_.
Linux Distribution Packages
===========================
*Not packaged yet.*
If you are interested in creating packages for Linux distributions, read the
`"Contribute" page </contribute/>`_.
If you are interested in creating packages for Linux distributions, `contact us </support/>`_.

40
pages/metadata.rst

@ -17,11 +17,11 @@ You can add per value metadata like labels, by specifying a dictionary instead o
.. pygal-code::
chart = pygal.Bar()
chart.add('Red', {'value': 2, 'label': 'This is red'})
chart.add('Green', {'value': 4, 'label': 'This is green'})
chart.add('Red', [{'value': 2, 'label': 'This is red'}])
chart.add('Green', [{'value': 4, 'label': 'This is green'}])
chart.add('Yellow', 7)
chart.add('Blue', {'value': 5})
chart.add('Violet', {'value': 3, 'label': 'This is violet'})
chart.add('Blue', [{'value': 5}])
chart.add('Violet', [{'value': 3, 'label': 'This is violet'}])
Links
@ -35,26 +35,26 @@ You can also add hyper links:
.. pygal-code::
chart = pygal.Bar()
chart.add('Red', {
chart.add('Red', [{
'value': 2,
'label': 'This is red',
'xlink': 'http://en.wikipedia.org/wiki/Red'})
'xlink': 'http://en.wikipedia.org/wiki/Red'}])
chart.add('Green', {
chart.add('Green', [{
'value': 4,
'label': 'This is green',
'xlink': 'http://en.wikipedia.org/wiki/Green'})
'xlink': 'http://en.wikipedia.org/wiki/Green'}])
chart.add('Yellow', 7)
chart.add('Blue', {
chart.add('Blue', [{
'value': 5,
'xlink': 'http://en.wikipedia.org/wiki/Blue'})
'xlink': 'http://en.wikipedia.org/wiki/Blue'}])
chart.add('Violet', {
chart.add('Violet', [{
'value': 3,
'label': 'This is violet',
'xlink': 'http://en.wikipedia.org/wiki/Violet_(color)'})
'xlink': 'http://en.wikipedia.org/wiki/Violet_(color)'}])
Advanced
@ -65,35 +65,35 @@ You can specify a dictionary to xlink with all links attributes:
.. pygal-code::
chart = pygal.Bar()
chart.add('Red', {
chart.add('Red', [{
'value': 2,
'label': 'This is red',
'xlink': {'href': 'http://en.wikipedia.org/wiki/Red'}})
'xlink': {'href': 'http://en.wikipedia.org/wiki/Red'}}])
chart.add('Green', {
chart.add('Green', [{
'value': 4,
'label': 'This is green',
'xlink': {
'href': 'http://en.wikipedia.org/wiki/Green',
'target': '_top'}
})
}])
chart.add('Yellow', 7)
chart.add('Blue', {
chart.add('Blue', [{
'value': 5,
'xlink': {
'href': 'http://en.wikipedia.org/wiki/Blue',
'target': '_blank'}
})
}])
chart.add('Violet', {
chart.add('Violet', [{
'value': 3,
'label': 'This is violet',
'xlink': {
'href': 'http://en.wikipedia.org/wiki/Violet_(color)',
'target': '_self'}
})
}])

2
pages/other_customizations.rst

@ -25,7 +25,7 @@ You can set the scale to be logarithmic:
.. caution::
Negative values are ignored, interpolation might be broken if it goes below zero...
Negative values are ignored
Custom css and js

18
pages/support.rst

@ -0,0 +1,18 @@
=========
Support
=========
IRC
===
For fast support, try our irc channel `##kozea <irc://chat.freenode.net/##kozea>`_ on
`Freenode <http://freenode.net/>`_.
Github
======
Submit your bug reports and your feature requests to the `github bug tracker <http://github.com/Kozea/pygal/issues>`_.
Never hesitate to fork the project on github.
Pull requests are always welcomed.

33
static/css/style.css

@ -103,7 +103,7 @@ nav {
font-size: 1.1em;
position: absolute;
top: 70px;
right: 5%;
right: 8%;
}
nav ul {
@ -287,6 +287,10 @@ footer {
}
footer ul li {
list-style-type: none;
}
footer ul li a {
color: #6c6c6c;
margin: 0 5px;
@ -297,3 +301,30 @@ footer ul li a:hover,
footer ul li a:focus {
color: #8b8b8b;
}
/*
----------
- RIBBON -
----------
*/
.ribbon {
background: linear-gradient(#E95355, #D63739);
overflow: hidden;
position: fixed;
right: -3em;
top: 2em;
transform: rotate(45deg);
box-shadow: 0 0 1em #888;
}
.ribbon a {
font: bold .8em "philisopher";
border: 1px solid #faa;
color: #fff;
display: block;
margin: 0.05em 0 0.075em 0;
padding: 0.5em 3.5em;
text-align: center;
text-decoration: none;
text-shadow: 0 0 0.5em #444;
}

Loading…
Cancel
Save