[Sugar-devel] Sugar docs
simon at schampijer.de
Thu Feb 23 12:34:32 EST 2012
On 02/23/2012 05:45 PM, Walter Bender wrote:
> On Thu, Feb 23, 2012 at 10:47 AM, Walter Bender<walter.bender at gmail.com> wrote:
>> On Thu, Feb 23, 2012 at 10:05 AM, Simon Schampijer<simon at schampijer.de> wrote:
>>> On 02/20/2012 04:08 PM, Bastien wrote:
>>>> Hi Simon,
>>>> Simon Schampijer<simon at schampijer.de> writes:
>>>>> is this  the latest version of the Sugar docs? What is the current
>>>>> process for updates (e.g. the upcoming 0.96). Is there someone working on
>>>>> that end? There were questions here at the GNOME doc hackfest  what
>>>>> Sugar is doing for documentation and I am not sure if I am fully up to
>>>> At the SugarCamp in Paris, I brievely mentioned readthedocs:
>>>> Florent Pigout told me about this service, which looks quite
>>>> nice. Maybe the Sugar community could use something like this
>>>> instead of FlossManuals? FM may be suitable for end-users docs
>>>> but not that much for developers docs.
>>> GNOME does use mallard  for their documentation in the docs (yelp). The
>>> concept of "topic-oriented" documentation is nice, I think. Furthermore
>>> using the same tools as GNOME could help in people doing documentation in
>>> both projects. When people want to update the current floss manuals they
>>> could maybe evaluate this first.
>>> We could use mallard as well for API docs, see for example Tomeu's work on
>>> documenting the Python API docs from introspection , the current API
>>> documentation looks rather outdated . Would be a nice project for someone
>>> to work on it.
>>>  http://projectmallard.org/
>>>  http://doc.sugarlabs.org/epydocs/
>>> Sugar-devel mailing list
>>> Sugar-devel at lists.sugarlabs.org
>> Just started a simple example of mallard for Turtle Art. I have to
>> admit I enjoy writing documentation in emacs much better than using a
>> WYSIWYG editor. +1 to mallard.
There seem to be modes for gedit and emacs around.
>> Walter Bender
>> Sugar Labs
> I didn't see it anywhere in the basic mallard docs, but is there a
> decent i18n schema? In the case of TA, ideally I could reuse all the
> existing help strings from the .po file. That'd cover the bulk of what
> I'd need in the manual. I also need to look into generating svgs by
> language for the manual.
Maybe those answers a few questions about this matter:
> Do we have a yelp Sugar activity?
We have the help activity, which we use to display the help pages. I did
gave it a quick shot and created a few mallard files with the 10 minutes
example . Then I processed those to html with 'gnome-doc-tool html
<directory with mallard files>'. And tadada: we have html documentation
we can use in any Browser (or a webkit view in the help activity).
More information about the Sugar-devel