Pyglet 1.2alpha1 Documentation

[Hello3171]

The new (html) documentation for pyglet 1.2alpha1 seems very limited compared to the previous documentation. For example, I see absolutely no way to get to the Sprite class (getting to the module pyglet.sprite is fine - but it doesn't offer any links to the Sprite class). Am I really just looking in all the wrong places? If that is the case then it is clear to me that the new documentation isn't as clear as it should be.

[Txema Vicente]

El 26/08/2012 15:21, Hello3171 escribi�:

> The new (html) documentation for pyglet 1.2alpha1 seems very limited
> compared to the previous documentation. For example, I see absolutely
> no way to get to the Sprite class (getting to the module pyglet.sprite
> is fine - but it doesn't offer any links to the Sprite class).

The link should be there, as in all modules, at "Classes" section.
http://code.nabla.net/doc/pyglet/api/pyglet/pyglet.sprite.html#classes

> Am I really just looking in all the wrong places? If that is the case
> then it is clear to me that the new documentation isn't as clear as it

> should be. --

You can also find the Sprite class in the Index, and using the search box.
The contents are the same, generated from the same source docstrings.
If you have any concrete proposal to improveit, I'm all ears.

> You received this message because you are subscribed to the Google
> Groups "pyglet-users" group.
> To view this discussion on the web visit
> https://groups.google.com/d/msg/pyglet-users/-/M5pn5-uOpHEJ.
> To post to this group, send email to pyglet...@googlegroups.com.
> To unsubscribe from this group, send email to
> pyglet-users...@googlegroups.com.
> For more options, visit this group at
> http://groups.google.com/group/pyglet-users?hl=en.

[Hello3171]

Well I downloaded the documentation zip file again from http://code.google.com/p/pyglet/downloads/detail?name=pyglet-docs-1.2alpha1.zip&can=2&q=1.2alpha1. The problems are that:

1) The search box doesn't work (in chrome). It remains stuck on "Searching..." with the animated dots.

2) There is no classes section.

3) The sprite stuff just isn't in the index. (A lot of things are missing.)

To show the differences clearly I attached three images to show what I can see.

On Sunday, August 26, 2012 4:56:58 PM UTC+1, Txema Vicente wrote:

El 26/08/2012 15:21, Hello3171 escribi�:

[Txema Vicente]

You are right, the docs are now broken, both the zip and the source.

It is because the autosummary must be referenced to find all classes, and it has been removed from index.txt.

.. autosummary::

   :toctree: api/ 

   :template: package.rst

 

   pyglet

   tests.test

I will fix it and try to remove this requirement and say something soon.

2012/8/28 Hello3171 <hell...@gmail.com>

--

You received this message because you are subscribed to the Google Groups "pyglet-users" group.

To view this discussion on the web visit https://groups.google.com/d/msg/pyglet-users/-/QXs5CBmAxY4J.

[Txema Vicente]

Hi.

The search page problem seems to come with sphinx:

http://www.mail-archive.com/sphin...@googlegroups.com/msg05613.html

The autosummary directive is still mandatory, but I have added a "hidden" property, now it  

is included at the beginning of index.txt and does not affect the page content.

I uploaded the last documentation here:

http://code.nabla.net/doc/pyglet/pyglet-docs-html-txema.zip 

If you see something wrong, please let me know.

This changes will be available at:

https://code.google.com/r/txema-pyglet-doc/

[Hello3171]

The changes work as advertised. Thanks!