Documentation?

[Alex Grönholm]

Is there any reference documentation for Pycha anywhere, or is the project dead?

[Lorenzo Gil Sanchez]

2011/7/15 Alex Grönholm <alex.g...@nextday.fi>:

> Is there any reference documentation for Pycha anywhere, or is the project
> dead?

The documentation is at http://packages.python.org/pycha/ You will
find that the options reference is not yet written but there is an
alternate way to learn all the options: use the chavier interactive
application, which lets you create a sample chart and play changing
all the options.

You can find the docs link from the pypi pycha page:
http://pypi.python.org/pypi/pycha

How did you try to find it? I'd like to know it to improve the
findability of the docs.

And by the way, the project is not dead, just a little bit asleep :-)

Best regards,

Lorenzo

[Alex Grönholm]

15.07.2011 08:58, Lorenzo Gil Sanchez kirjoitti:

2011/7/15 Alex Grönholm <alex.g...@nextday.fi>:

Is there any reference documentation for Pycha anywhere, or is the project
dead?

The documentation is at http://packages.python.org/pycha/ You will
find that the options reference is not yet written but there is an
alternate way to learn all the options: use the chavier interactive
application, which lets you create a sample chart and play changing
all the options.

You can find the docs link from the pypi pycha page:
http://pypi.python.org/pypi/pycha

How did you try to find it? I'd like to know it to improve the
findability of the docs.

You're right -- I should have found it from the PyPI page.
However, Pycha's bitbucket home page says:

Adam Przywecki has done a fantastic work writing documentation for Pycha. Check it out at http://pycha.yourwei.com/

And that is a dead link. There was no link to the current documentation from the bitbucket page.
The generation of reference documentation can be largely automated with Sphinx, assuming properly formatted docstrings.

[Adam Przywecki]

Hello,

Sorry, that was my site which is now indeed offline. I think that I
still have the docs somewhere, but they are a few versions behind. I
can send them to anyone who wants to update them.

Adam

2011/7/15 Alex Grönholm <alex.g...@nextday.fi>:

> --
> You received this message because you are subscribed to the Google Groups
> "pycha" group.
> To post to this group, send email to py...@googlegroups.com.
> To unsubscribe from this group, send email to
> pycha+un...@googlegroups.com.
> For more options, visit this group at
> http://groups.google.com/group/pycha?hl=en.
>

[Leandro Regueiro]

A few comments about the docs. Don't take them the bad way, just are
things I see maybe could be improved.

You should put something in
http://packages.python.org/pycha/options.html . Right now is totally
blank.

In http://packages.python.org/pycha/tutorial.html you list the five
steps, but they are not clearly differentiated in the page. If you
create a section for each step it may be easier to understand the
tutorial, and this five steps will appear in the index page:
http://packages.python.org/pycha/index.html

In the first page I can read «Now we can deliver charts to people with
JavaScript disabled or embed them in PDF reports» but no example to do
this is on the docs. Maybe you can write one simple example or at
least point to some example file in Pycha in
http://packages.python.org/pycha/examples.html#other-examples

I suggest to put the other examples referenced in
http://packages.python.org/pycha/examples.html#other-examples in the
docs, explained with the same level of detail as the examples already
included.

The code in the section
http://packages.python.org/pycha/examples.html#pie-charts is not
highlighted, but the other examples code in the same page are
highlighted. It is minor thing, but the highlighted code make easier
to understand it, IMHO.

I recommend you NOT to put "release notes" in the docs:
http://packages.python.org/pycha/release-notes.html . If you don't
think this way, put at least the "autopadding" and "custom colors" in
a way that they are visible in the index page
http://packages.python.org/pycha/index.html

If you click on index you go to
http://packages.python.org/pycha/genindex.html where you can see
nothing. You may correct the "index" links to point to
http://packages.python.org/pycha/index.html

Bye

[Lorenzo Gil Sanchez]

Hi Leandro

2011/7/18 Leandro Regueiro <leandro....@gmail.com>:

Thanks for you suggestions. I think they all are valuable comments.
Some things are easier to fix than others and you didn't mention that
my english is not that good even when that's another issue.

I would really appreciate some documentation patches. Adam Przywecki
did it some time ago and that was the beginning of our documentation.
Even when it is not perfect, it is far better that what we had before,
which was nothing. I have updated Adam's initial docs but as you noted
there is still much room for improvements.

Best regards,

Lorenzo

[Lorenzo Gil Sanchez]

I started to fix the docs following Leandro's advice:

https://bitbucket.org/lgs/pycha/changeset/11a3ad256e04
https://bitbucket.org/lgs/pycha/changeset/1a6f42776a1b

I'll keep doing this on my vacations unless someone is willing to help me :-)

Best regards,

Lorenzo

2011/7/18 Lorenzo Gil Sanchez <lorenzo.g...@gmail.com>: