Additional documentation formats

View: New views
4 Messages — Rating Filter:   Alert me  

Additional documentation formats

by Age Bosma-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message


I'd like to create a MochiKit add-on pack for the DevBoi sidebar
Firefox add-on [1]. This will provide a handy reference.
Is the MochiKit documentation by any chance available in XML/RDF
format or JSON even? I'm not talking about everything like the
examples and stuff, just the basis like a list of all methods with
description, return value, etc. I wouldn't be surprised if this is the
case but I wasn't able to find it. Since the info presented in the
sidebar is from XML/RDF files it would save me time not having to
create one manually for MochiKit from scratch.

Yours,

Age


[1] https://addons.mozilla.org/en-US/firefox/addon/1317

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


Re: Additional documentation formats

by Per Cederberg-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message


The MochiKit documentation sources are in rst format. See Python
docutils for information if something different than HTML can be
generated from that.

Cheers,

/Per

On Wed, Jun 25, 2008 at 12:59 AM, Prodoc <agebosma@...> wrote:

>
> I'd like to create a MochiKit add-on pack for the DevBoi sidebar
> Firefox add-on [1]. This will provide a handy reference.
> Is the MochiKit documentation by any chance available in XML/RDF
> format or JSON even? I'm not talking about everything like the
> examples and stuff, just the basis like a list of all methods with
> description, return value, etc. I wouldn't be surprised if this is the
> case but I wasn't able to find it. Since the info presented in the
> sidebar is from XML/RDF files it would save me time not having to
> create one manually for MochiKit from scratch.
>
> Yours,
>
> Age
>
>
> [1] https://addons.mozilla.org/en-US/firefox/addon/1317
>
> >
>

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


Re: Additional documentation formats

by Arnar Birgisson :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message


Hey there,

Is DevBoi an index to online docs? If so, regarding this thread:
http://groups.google.com/group/mochikit/browse_thread/thread/2d4946c76c11d6a0/9ff73cf87a4850fe?lnk=gst&q=got+api#9ff73cf87a4850fe

There is a script in the trunk to generate and XML index for gotapi.com:
http://trac.mochikit.com/browser/mochikit/trunk/scripts/gotapi.py

It scrapes the XHTML files rather than the original rst docs. It was
considerably easier that way.

cheers,
Arnar

On Tue, Jun 24, 2008 at 22:59, Prodoc <agebosma@...> wrote:

>
> I'd like to create a MochiKit add-on pack for the DevBoi sidebar
> Firefox add-on [1]. This will provide a handy reference.
> Is the MochiKit documentation by any chance available in XML/RDF
> format or JSON even? I'm not talking about everything like the
> examples and stuff, just the basis like a list of all methods with
> description, return value, etc. I wouldn't be surprised if this is the
> case but I wasn't able to find it. Since the info presented in the
> sidebar is from XML/RDF files it would save me time not having to
> create one manually for MochiKit from scratch.
>
> Yours,
>
> Age
>
>
> [1] https://addons.mozilla.org/en-US/firefox/addon/1317
>
> >
>

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


Re: Additional documentation formats

by Age Bosma-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message


On Jun 25, 1:41 pm, "Arnar Birgisson" <arna...@...> wrote:
> Hey there,
>
> Is DevBoi an index to online docs? If so, regarding this thread:http://groups.google.com/group/mochikit/browse_thread/thread/2d4946c7...
>

Great! Thank you for the info, very useful. Yes, DevBoi is basically
like that, only you don't have to go to a different site for the
index. It'll be available in the sidebar of Firefox instead. There are
offline and online versions of most indexes available but I'm mainly
interested in creating an index to the online docs.

In addition, have the docs ever been frozen for MochiKit 1.3.1?
Instead of creating an index of the ongoing docs it might be useful to
work release based. If for some reason people are forced to stick to a
specific release they'll have an index for that release only. I'm not
sure how likely this is though.

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

LightInTheBox - Buy quality products at wholesale price