Re: [pygame] Experimental, Classic Look, sphinx generated XHTML docs for Pygame 1.9.2a

[René Dudfield <renesd@xxxxxxxxx>]

Hey,

I love that the menu at the top has the correct first case lettering now :)

* For the TOC... rather than

    href="#tocentry-pygame-display-list-modes"

Can we have it like the old one?
   href="display.html#pygame.display.list_modes"


* Having the id on the dt is fine for me searching the area to add the
comments, and code search buttons in :)
* Comments can show up[and be up to date] on the downloaded version of
comments.  They can be injected with javascript.  By adding something
like <script src="http://pygame.org/comments.js"/> to the bottom of
the page.




On Wed, Mar 23, 2011 at 6:25 PM, Lenard Lindstrom <len-l@xxxxxxxxx> wrote:
> Hi René,
>
> The urls are the same as the current docs. But in XHTML the name attribute
> is deprecated in favor of the id attribute, which can be on any tag.
> Definitions are marked up as definition lists: <dl><dt
> id="relative.url">object name</dt><dd>description block</dd></dl> . I just
> updated the TOCs to jump to the dt tag directly rather than a span tag
> inserted in front of <dl>. Adding an anchor with the same id at the end of
> the dd block would duplicate the id, a no-no. I could set the id to
> something like "example-relative.url" (and use a span instead of an anchor).
>
> Lenard
>
> On 23/03/11 07:38 AM, René Dudfield wrote:
>>
>> Hi again,
>>
>> An anchor, rather than an id is probably needed for the urls anyway.
>> I can use that to place the comments... if that's easier than adding
>> an id.  eg, from the current html...<a
>> name="pygame.mixer.music.pause">
>>
>>
>> On Wed, Mar 23, 2011 at 11:16 AM, René Dudfield<renesd@xxxxxxxxx>  wrote:
>>
>>>
>>> Nice one!
>>>
>>> I haven't looked at them yet... but there's two other things we need to
>>> check.
>>>
>>> - urls
>>>     - if the urls are different, we will need to make a map from the
>>> current urls to the new urls.
>>>         - eg,
>>> http://www.pygame.org/docs/ref/music.html#pygame.mixer.music.load
>>>         - it would be best if they were the same urls of course, but if
>>> it's too hard then we can make a mapping.
>>>
>>> - comments.
>>>     - I'll need to change the code on the server which inserts the
>>> comment block (and the search google code button).
>>>     - if there is an id like "pygame.mixer.music.load" on each block, so
>>> I can easily add in the comment blocks into the relevant place inside the
>>> html.
>>>
>>>
>>> cya.
>>>
>>>
>>>
>>> On Wed, Mar 23, 2011 at 5:36 AM, Lenard Lindstrom<len-l@xxxxxxxxx>
>>>  wrote:
>>>
>>>>
>>>> Hello,
>>>>
>>>> On 22/03/11 08:33 PM, Ian Mallett wrote:
>>>>
>>>>>
>>>>> Hi,
>>>>>
>>>>>  From a VERY quick pass:
>>>>> -In pygame.draw.aalines, the function is listed incorrectly as
>>>>> "pygame.draw.pygame.draw.aalines".
>>>>>
>>>>
>>>> This was caused by a missing line the Pygame .doc file.
>>>>
>>>>
>>>>>
>>>>> -Maybe nicer formatting for pygame.key?
>>>>>
>>>>
>>>> The<pre />  block style wasn't set to a monospace font.
>>>>
>>>>
>>>>>
>>>>> -pygame.font.Font.metrics; typo on this line, should be "passed"
>>>>> -Typo: "Module" in pygame.math
>>>>> -pygame.surfarray.use_arraytype, probably should specify that the
>>>>> argument is a string
>>>>>
>>>>>
>>>>
>>>> Good to know. These will be corrected in the Pygame .doc files.
>>>>
>>>>
>>>>>
>>>>> On Chrome 10.0.648.151:
>>>>> -In many places, where there's plenty of space, the last word in a line
>>>>> is wrapped around to a new line; e.g., "applications" in
>>>>> pygame.event.set_grab, "fonts" in pygame.fonts.SysFont, "library" in
>>>>> pygame.freetype.quit, "file." in pygame.freetype.Font, etc.
>>>>>
>>>>
>>>> reST requires definite column widths. The algorithm for calculating them
>>>> was a little too clever. Also I didn't allow for the em-dash in the right
>>>> column.
>>>>
>>>>
>>>>>
>>>>> -Displays HTML instead of a link in pygame.movie (confirmed on Firefox
>>>>> 3.6.15).
>>>>> -Weird blocks in the pygame, pygame.sprite module (confirmed on
>>>>> Firefox).  Are these intentional?
>>>>>
>>>>>
>>>>
>>>> Some fixes will have to be done in reST should the document sources be
>>>> moved to reST.
>>>>
>>>> Lenard
>>>>
>>>>
>>>
>>>
>
>