First dirty API doc with Sphinx

[Luis Miguel Morillas]

I've uploaded to http://docs.xml3k.org/ a first test of an API Doc of
Amara built with Sphinx with sphinx-apidoc:

$ sphinx-apidoc -F -o ~/misdocs
'./amaras/lib/python2.7/site-packages/amara/' -H "Amara" -V "2.0" -R
"2.0.a6" -A "Uche Obuji & Zepheira"

Saludos,

-- luismiguel  (@lmorillas)

[Werner]

Hi Luis Miguel,

On 22/04/2012 19:25, Luis Miguel Morillas wrote:
> I've uploaded to http://docs.xml3k.org/ a first test of an API Doc of
> Amara built with Sphinx with sphinx-apidoc:
>
> $ sphinx-apidoc -F -o ~/misdocs
> './amaras/lib/python2.7/site-packages/amara/' -H "Amara" -V "2.0" -R
> "2.0.a6" -A "Uche Obuji& Zepheira"

We most have worked on this just about at the same time.

Did you get any Sphinx generation errors using the sphinx-apidoc ?

The stuff I use has a ".rst" generator which uses code from
sphinx-apidoc, but does some additional stuff like the "summary" and the
inheritance stuff and could also add widget screen shots (no use for Amara).

I'll do a little clean up on this today and zip it up.

Werner

[Luis Miguel Morillas]

El día 23 de abril de 2012 09:47, Werner <werner...@sfr.fr> escribió:
> Hi Luis Miguel,
>
>
> On 22/04/2012 19:25, Luis Miguel Morillas wrote:
>>
>> I've uploaded to http://docs.xml3k.org/ a first test of an API Doc of
>> Amara built with Sphinx with sphinx-apidoc:
>>
>> $ sphinx-apidoc -F -o ~/misdocs
>> './amaras/lib/python2.7/site-packages/amara/' -H "Amara" -V "2.0" -R
>> "2.0.a6" -A "Uche Obuji&  Zepheira"
>
> We most have worked on this just about at the same time.
>
> Did you get any Sphinx generation errors using the sphinx-apidoc ?
>

I'm attaching a cooked report of the errors that sphinx report.

Uche, we have old Ft imports at amara.xpath.extensions :P !

-- luismiguel

> The stuff I use has a ".rst" generator which uses code from sphinx-apidoc,
> but does some additional stuff like the "summary" and the inheritance stuff
> and could also add widget screen shots (no use for Amara).
>
> I'll do a little clean up on this today and zip it up.
>
> Werner
>

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

[Werner]

Good morning Luis Miguel,

On 23/04/2012 10:50, Luis Miguel Morillas wrote:
...

> I'm attaching a cooked report of the errors that sphinx report.

Did you generate against Amara released version or do you run it against
a newer build?

Most of these errors are just document string formatting issues.

I pulled Amara from git, what do I need to do to build it and can I
build it to another folder then my installed Python site-packages?

I am on Windows 7 with Python 2.7 32-bit and I barely know how to spell
"C++" ;-) .

Werner

[Luis Miguel Morillas]

El día 23 de abril de 2012 10:58, Werner <werner...@sfr.fr> escribió:
> Good morning Luis Miguel,
>
Bonjour, Werner!

> On 23/04/2012 10:50, Luis Miguel Morillas wrote:
> ...
>
>> I'm attaching a cooked report of the errors that sphinx report.
>
> Did you generate against Amara released version or do you run it against a
> newer build?
>

I generated it against a fresh install with virtualenv.

> Most of these errors are just document string formatting issues.
>

yep

> I pulled Amara from git, what do I need to do to build it and can I build it
> to another folder then my installed Python site-packages?
>
> I am on Windows 7 with Python 2.7 32-bit and I barely know how to spell
> "C++" ;-) .
>

:)

Do you use virtualenv? I wrote some help about installing Amara on
windows here: http://wiki.xml3k.org/Amara/Windows

Tell me if something doesn't work.

-- luismiguel

[Werner]

Hi,

>> I pulled Amara from git, what do I need to do to build it and can I build it
>> to another folder then my installed Python site-packages?
>>
>> I am on Windows 7 with Python 2.7 32-bit and I barely know how to spell
>> "C++" ;-) .
>>
> :)
>
> Do you use virtualenv? I wrote some help about installing Amara on
> windows here: http://wiki.xml3k.org/Amara/Windows
>
>

Have used virtualenv before, so shouldn't have a problem with that.
Could I somehow use pre-build C extensions and use the .py stuff from git?

Werner

[Luis Miguel Morillas]

You can download full installers for Windows from
http://wiki.xml3k.org/Amara/Windows

-- lm

[Werner]

Hi,

On 23/04/2012 11:34, Luis Miguel Morillas wrote:
...

>> Have used virtualenv before, so shouldn't have a problem with that. Could I
>> somehow use pre-build C extensions and use the .py stuff from git?
>>
> You can download full installers for Windows from
> http://wiki.xml3k.org/Amara/Windows

Are there somewhere nightly builds of these? I like to get as close to
what is current on git without having to do anything with the C/C++ stuff.

Werner

[Luis Miguel Morillas]

Nope. The are not automated yet. But they are updated because last
commit on amara repo was 8 months ago [1] As Uche said, last year we
worked not on code itself but in interesting applications with amara &
akara.

[1] https://github.com/zepheira/amara/commits/master

-- luismiguel