[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]

Re: [pygame] Sphinx versions

Hi Rene,
All fixed data files can go into docs/reST/_static. They will be copied to docs/_static by makeref.py. Then those can be added to svn as well. This would probably be the place for docscomment.json. I'm not so sure about the JavaScript app. It probably can go there as well.
Sphinx uses Jinja2 templates to lay out the document and add boilerplate. Our custom templates are in docs/reST/themes/classic. The script tag would added to elements.html. If you want the tag within the bright green "relbar" at the bottom of the page then the add {%- block relbaritems %}html code goes here.{% endblock %} to the end elements.html. If you just want to email me the code snippet I can add it and commit the changes. 

Lenard

On 01/06/11 10:26 AM, René Dudfield wrote:

Hi Lennard,

I'd like to include some new files with the docs.
docscomment.json - generated from the website comments, which contains all the comments. Plus a jquery plugin jquery.plugin.docscomment.js which should be included in a script tag in the footer of the page.
Do you have any idea on where I'd add these files into the sphinx step? I've made the two files, I just need to put them in the file system somewhere, and insert the script tag into the footer of html that gets generated.
I guess the jquery.plugin.docscomment.js would go in docs/, and the docscomment.json would go in docs/ref/. Sound ok?
I have no idea where to add the script tag into the template. Do you know? 

cheers,
On Wed, Jun 1, 2011 at 8:47 AM, René Dudfield <renesd@xxxxxxxxx <mailto:renesd@xxxxxxxxx>> wrote: 



    On Tue, May 31, 2011 at 3:48 AM, Lenard Lindstrom <len-l@xxxxxxxxx
    <mailto:len-l@xxxxxxxxx>> wrote:

        P.S.

        Which Sphinx version are you using?


    Hi,

    1.0.7

    I think I pip install'd it.