(there are two big threads, so this might have been covered)
1] Is there a method other projects use, that we could copy?
2] I would definitely push for a web wiki-interface (at least to allow
'comment's section of current docs )
* allows correction submitions ( mentioned in other thread )
* wou
Hi Jake,
Pygame does have a document generator, but it is tucked away in an
obscured directory and only processes Python files. Sphinx also comes
with a document generator. But first we would have to convert all the
doc strings to reST markup. Also, how would a doc generator handle
module lev
Why not use a doc-generater?
It sounds like the current method you have to write the docstring twice.
( or at least decreases ease to update )
--
Jake
Hi,
those two modules are experimental in the current 1.9.1 release.
cheers,
On Tue, Mar 1, 2011 at 3:23 PM, Marcel Rodrigues wrote:
> At the top of the page in http://www.pygame.org/docs/ there are a list of
> links to module docs. I just noticed that this list is lacking links to
> Camera and
I have seen problems with Internet Explorer, especially with spaces in
the path (though there are none here). I guess I didn't fix everything.
Lenard
On 01/03/11 10:30 AM, David Burton wrote:
Thanks, Lenard.
However, those commands don't work for me with either python 2.6 or
3.1. It fires u
Hi Julian,
Thanks, I will use you documents as a guide. Actually I was going to
format the documents for Sphinx, like with pgreloaded, but now see that
*is* reStructuredText. I intended to use a modified makeref.py to do the
initial translation, then go from there. The one downside in switchin
Hi,
Am 01.03.2011 18:44, schrieb Lenard Lindstrom:
Personally, I am considering translating them to reStructuredText or
something.
That's exactly what I did quite a while ago:
https://bitbucket.org/schlangen/pygame-docs/
The aim was to include it here: http://pygameweb.no-ip.org/docs/ (Of
co
Hi David,
The .doc files are not actually Microsoft Word documents, but a custom
text based format for Pygame. The HTML is then generated with the
makeref.py tool, which is part of the Pygame source. To download the
source, and documents:
svn co svn://seul.org/svn/pygame/trunk
Each module's
Thanks, Lenard.
However, those commands don't work for me with either python 2.6 or 3.1. It
fires up my web browser but just shows my home page. But simply opening
file:///C:/python31/Lib/site-packages/pygame/docs/index.html in a web
browser works.
However, that version of the documenation is l
Hi,
I guess it is not a well advertised feature, but more recent docs are
installed with Pygame. Try:
python -m pygame.docs
(or python -m pygamd.docs.__main__for python 2.6)
This should bring up the local copy in a browser. If not, they are found
in site-packages/pygame/docs
But y
There are many other errors in the docs, too. Click "show all comments" and
read the comments on the various documentation pages to read about them.
They don't appear to have been updated in a long time.
Is anyone "in charge of" those documents? Is there a way to volunteer to
fix some of the pr
At the top of the page in http://www.pygame.org/docs/ there are a list of
links to module docs. I just noticed that this list is lacking links to
Camera and Midi modules. These two modules are properly linked from any
other module page (e.g. /docs/ref/color.html ), but not from /docs/ . Also,
the l
12 matches
Mail list logo
