Browse Source

Add the beginning of the documentation

pull/36/head
Florian Mounier 13 years ago
parent
commit
23c729afa8
  1. 2
      configuration.yaml
  2. 15
      pages/documentation.rst
  3. 25
      pages/first_steps.rst
  4. 3
      pages/home.rst

2
configuration.yaml

@ -5,6 +5,8 @@ public: true
url: http://www.pygal.org/ url: http://www.pygal.org/
menu: menu:
- Documentation:
link: /documentation/
- Contribute: - Contribute:
link: /contribute/ link: /contribute/
- Download: - Download:

15
pages/documentation.rst

@ -0,0 +1,15 @@
===============
Documentation
===============
User documentation
==================
- `First steps </first_steps>`_
Developper documentation
========================
*TODO*

25
pages/first_steps.rst

@ -0,0 +1,25 @@
===============
Documentation
===============
First steps
===========
First you need to download the pygal package, see the `download page </download>`_.
When it's done, you are ready to make your first chart:
.. code-block:: python
import pygal # First import pygal
bar_chart = pygal.Bar() # Then create a bar graph object
bar_chart.add('Fibonacci', [0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55]) # Add some values
bar_chart.render_to_file('bar_chart.svg') # Save the svg to a file
Now you have a svg file called `bar_chart.svg` in your current directory.
You can open it with various programs such as your web browser, inkscape or any svg compatible viewer.

3
pages/home.rst

@ -27,6 +27,9 @@ And a lot of options to customize the charts.
Technical Description Technical Description
===================== =====================
As of now pygal is known to work for python 2.7
Needed dependencies Needed dependencies
------------------- -------------------

Loading…
Cancel
Save