Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation system: pydocs doesn't work properly. #57

Closed
rec opened this issue Jan 18, 2013 · 5 comments
Closed

Documentation system: pydocs doesn't work properly. #57

rec opened this issue Jan 18, 2013 · 5 comments
Assignees
Milestone

Comments

@rec
Copy link
Collaborator

rec commented Jan 18, 2013

No description provided.

@ghost ghost assigned rec Jan 18, 2013
@rec
Copy link
Collaborator Author

rec commented Jan 18, 2013

It's seeming likely that Sphinx is the answer - at least, everyone recommends that first.

http://sphinx-doc.org/index.html

Looking into it now.

@tipam
Copy link
Owner

tipam commented Jan 21, 2013

I’ve just tried out Doxygen which seems to work quite well … I did docs on the integration branch so I can get to grips with what’s what!

Try this link www.skillmanmedia.com/pi3d/pi3des2/docs/index.html to see what it looks like.

Tim

From: Tom Swirly [mailto:notifications@github.com]
Sent: 18 January 2013 17:18
To: tipam/pi3d
Subject: Re: [pi3d] Documentation system: pydocs doesn't work properly. (#57)

It's seeming likely that Sphinx is the answer - at least, everyone recommends that first.

http://sphinx-doc.org/index.html

Looking into it now.


Reply to this email directly or view it on GitHub #57 (comment) .

https://github.com/notifications/beacon/J6T91GIPIyhU-8ti4GCGPy7_EydHpLqCSi_bWuXundF9_K5y6lx4DNUS_P952J-v.gif

No virus found in this message.
Checked by AVG - www.avg.com
Version: 2013.0.2890 / Virus Database: 2638/6026 - Release Date: 01/11/13
Internal Virus Database is out of date.

@rec
Copy link
Collaborator Author

rec commented Jan 21, 2013

I have had good success with Doxygen in past C++ projects...

On Mon, Jan 21, 2013 at 5:09 PM, Tim Skillmam notifications@github.comwrote:

I’ve just tried out Doxygen which seems to work quite well … I did docs on
the integration branch so I can get to grips with what’s what!

Try this link www.skillmanmedia.com/pi3d/pi3des2/docs/index.html to see
what it looks like.

Tim

From: Tom Swirly [mailto:notifications@github.com]
Sent: 18 January 2013 17:18
To: tipam/pi3d
Subject: Re: [pi3d] Documentation system: pydocs doesn't work properly.
(#57)

It's seeming likely that Sphinx is the answer - at least, everyone
recommends that first.

http://sphinx-doc.org/index.html

Looking into it now.


Reply to this email directly or view it on GitHub <
https://github.com/tipam/pi3d/issues/57#issuecomment-12431825> .

<
https://github.com/notifications/beacon/J6T91GIPIyhU-8ti4GCGPy7_EydHpLqCSi_bWuXundF9_K5y6lx4DNUS_P952J-v.gif>

No virus found in this message.
Checked by AVG - www.avg.com
Version: 2013.0.2890 / Virus Database: 2638/6026 - Release Date: 01/11/13
Internal Virus Database is out of date.


Reply to this email directly or view it on GitHubhttps://github.com//issues/57#issuecomment-12520130.

 /t

http://radio.swirly.com - art music radio 24/7 366/1000

@paddywwoof
Copy link
Collaborator

Those eg documents look fantastic and make my rather amateur comments
look very official! And the system of having the demos/*.py as text
documents is just what we want (I think). Doxygen it is (especially as
Tom has used it before, I haven't used either Doxygen or sphinx so I'm
agnostic on the choice)

On a completely different topic I got this email today and here's my
reply. I will have a quick look at it as I think it does need a better
solution. Note also his comment about wanting to do graphics without X
which we talked about a while ago.

<<<<<<<<<<<
Antanta

Glad to be contacted by anyone sharing thoughts or criticisms.

I have definitely neglected the 2D stuff. Basically everything that
the opengl es 2 version renders is done using a 3D Shape with an array
of verices, normals, indices and texture coordinates (if textured) and
(even the simplest) ImageSprite is drawn as two triangles. It is likely
that there will be a bit of rounding in calculating the pixel location
(though you could try adding or subtracting 1 from the width and height)

This issue has cropped up before but I have put it to one side as
secondary because it is possible to simulate 2D images using the 3D
Shapes. However it is also pretty easy to get the fragment shader to
render pixel perfect as it 'knows' which pixel it is writing to and can
work out the location of that pixel in the supplied texture to great
accuracy.

I have already done something like this, but more complicated, in the
Defocus class using defocus shader. It captures the rendered image to a
buffer that it then uses as a texture to redraw with different amounts
of blur. I will have a go at something tomorrow as simple image
rendering (at very high speed) is something that lots of people will
probably use pi3d for.

Paddy

On 21/01/2013 15:31, Ananta Palani wrote:

Hi Patrick,

I saw that you were most active on the pi3d code lately and thought I
might have encountered a bug. Sorry for the e-mail out of the blue.

I am trying to display 2D images with pixel perfect accuracy using pi3d
(so that I don't have to run X and can have easily maintainable python
code rather than C code). I have downloaded the latest integration code
(as of today), but when using an ImageSprite, although I can get the
image to display the correct size, there is definitely some scaling
going on. I have attached a simple example that uses textures which are
a checkerboard of alternating white and black pixels. When the texture
aligns perfectly with the monitor then the image should look uniformly
gray from a distance with no jagged edges or pattern shifts, and from up
close it should be possible to distinguish individual alternating
white/black pixels. Ideally you would choose one of textures that
matches your vertical monitor resolution. Why aren't these images
displayed correctly? Is there a better way to write pixels directly to a
frame / pixel buffer from python?

Thanks for all your hard work and sorry for troubling you!

Best,
-Ananta

On 21/01/2013 22:11, Tom Swirly wrote:

I have had good success with Doxygen in past C++ projects...

On Mon, Jan 21, 2013 at 5:09 PM, Tim Skillmam
notifications@github.comwrote:

I’ve just tried out Doxygen which seems to work quite well … I did
docs on
the integration branch so I can get to grips with what’s what!

Try this link www.skillmanmedia.com/pi3d/pi3des2/docs/index.html to see
what it looks like.

Tim

From: Tom Swirly [mailto:notifications@github.com]
Sent: 18 January 2013 17:18
To: tipam/pi3d
Subject: Re: [pi3d] Documentation system: pydocs doesn't work properly.
(#57)

It's seeming likely that Sphinx is the answer - at least, everyone
recommends that first.

http://sphinx-doc.org/index.html

Looking into it now.


Reply to this email directly or view it on GitHub <
https://github.com/tipam/pi3d/issues/57#issuecomment-12431825> .

<

https://github.com/notifications/beacon/J6T91GIPIyhU-8ti4GCGPy7_EydHpLqCSi_bWuXundF9_K5y6lx4DNUS_P952J-v.gif>

No virus found in this message.
Checked by AVG - www.avg.com
Version: 2013.0.2890 / Virus Database: 2638/6026 - Release Date:
01/11/13
Internal Virus Database is out of date.


Reply to this email directly or view it on
GitHubhttps://github.com//issues/57#issuecomment-12520130.

/t

http://radio.swirly.com - art music radio 24/7 366/1000


Reply to this email directly or view it on GitHub
#57 (comment).

@paddywwoof
Copy link
Collaborator

opted for sphinx

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants