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

Re: [pygame] Update PyGame website?

Thanks for the tip. I could get the documentation built on Linux without too much fuss. I wrote down documentation in case anyone else needs it:

Paul Vincent Craven

On Mon, Nov 5, 2012 at 4:29 PM, Ryan Hope <rmh3093@xxxxxxxxx> wrote:
Now if the code were on github, we could use the site website feature,
which can be updated by commiting to a specific branch. Then someone
could just run the sphinx build and commit and it would be updated.
This could even be automated with hooks so it happens automatically
when devs make commits.

On Mon, Nov 5, 2012 at 5:25 PM, Paul Vincent Craven
<paul@xxxxxxxxxxxxxxxx> wrote:
> I'll try running the code through Sphinx and see what docs come out right
> now, and how we might add to the those docs to make them better.
> Paul Vincent Craven
> On Mon, Nov 5, 2012 at 3:35 PM, Sam Bull <sam.hacking@xxxxxxxx> wrote:
>> On Mon, 2012-11-05 at 14:31 -0500, Ryan Hope wrote:
>> > Why isn't the documentation generated from source based comments with
>> > something like Sphinx?
>> The documentation is created with Sphinx, though I don't think it's
>> automated through docstrings unfortunately. I've used Sphinx to generate
>> a Devhelp version of the documentation before.
>>         I believe the website is manually updated from the Sphinx docs on
>> a
>> very infrequent basis, so it would be nice if it was automatically
>> updated once a week or something.
>> --
>> PGP: 9626CE2B
>> Twitter/Identi.ca: @sambull

Ryan Hope, M.S.
CogWorks Lab
Cognitive Science Department
Rensselaer Polytechnic Institute