[Python-modules-team] Bug#747567: Bug#747567: python3-pygame doesn't contain Pygame's documentation

[Vincent Cheng]

On Sun, May 11, 2014 at 8:07 AM, Jonathan Ballet <jon at multani.info> wrote:
> On Fri, May 09, 2014 at 07:57:33PM -0700, Vincent Cheng wrote:
> V> Hi Jonathan,
>>
>> On Fri, May 9, 2014 at 7:48 PM, Jonathan Ballet <jon at multani.info> wrote:
>> > Package: python3-pygame
>> > Version: 1.9.2~pre~r3348-1
>> > Severity: normal
>> >
>> > Dear Maintainer,
>> >
>> > at the moment, python3-pygame only contains tutorials but
>> > not the reference documentation (API, etc.)
>> > However, python-pygame does contain everything.
>> >
>> > danio:~$ dpkg -L python3-pygame | grep html
>> > /usr/lib/python3/dist-packages/pygame/install.html
>> > /usr/lib/python3/dist-packages/pygame/readme.html
>> > /usr/lib/python3/dist-packages/pygame/docs/logos.html
>> > /usr/lib/python3/dist-packages/pygame/docs/tut/MoveIt.html
>> > /usr/lib/python3/dist-packages/pygame/docs/tut/ImportInit.html
>> > /usr/lib/python3/dist-packages/pygame/docs/tut/DisplayModes.html
>> > /usr/lib/python3/dist-packages/pygame/docs/tut/camera/CameraIntro.html
>> > /usr/lib/python3/dist-packages/pygame/docs/tut/tom/games6.html
>> > /usr/lib/python3/dist-packages/pygame/docs/tut/tom/games5.html
>> > /usr/lib/python3/dist-packages/pygame/docs/tut/tom/games4.html
>> > /usr/lib/python3/dist-packages/pygame/docs/tut/tom/games3.html
>> > /usr/lib/python3/dist-packages/pygame/docs/tut/tom/games2.html
>> > /usr/lib/python3/dist-packages/pygame/docs/tut/tom/MakeGames.html
>> > /usr/lib/python3/dist-packages/pygame/docs/tut/surfarray/SurfarrayIntro.html
>> > /usr/lib/python3/dist-packages/pygame/docs/tut/intro/intro.html
>> > /usr/lib/python3/dist-packages/pygame/docs/tut/chimp/chimp.py.html
>> > /usr/lib/python3/dist-packages/pygame/docs/tut/chimp/ChimpLineByLine.html
>> > /usr/lib/python3/dist-packages/pygame/docs/ref/pygame_cursor.html
>> > /usr/lib/python3/dist-packages/pygame/docs/ref/index.html
>> > danio:~$ dpkg -L python-pygame | grep html
>> > /usr/share/doc/python-pygame/logos.html
>> > /usr/share/doc/python-pygame/tut/newbieguide.html
>> > [...]
>> > /usr/share/doc/python-pygame/tut/MoveIt.html
>> > /usr/share/doc/python-pygame/ref/locals.html
>> > /usr/share/doc/python-pygame/ref/mixer.html
>> > /usr/share/doc/python-pygame/ref/tests.html
>> > /usr/share/doc/python-pygame/ref/draw.html
>> > /usr/share/doc/python-pygame/ref/mouse.html
>> > /usr/share/doc/python-pygame/ref/movie.html
>> > /usr/share/doc/python-pygame/ref/surfarray.html
>> > /usr/share/doc/python-pygame/ref/cdrom.html
>> > [...]
>> >
>> > Is it possible to provide the documentation without having to install
>> > both packages?
>> >
>> > (On a side note, this documentation should probably be moved to
>> > /usr/share/doc instead of being shipped in the Python package
>> > directory.)
>>
>> It's on my todo list (along with other things like migrating to
>> pybuild and running the test suite with xvfb, etc.), but I doubt I'll
>> have time to get around to this anytime soon. Anyways, patches welcome
>> as always. :)
>
> I would love to help, but as much as I've been using Debian, it seems my
> head can't fit how to properly set up, build and/or hack on Debian
> packaging :/
> If you ever make a patch (or at worst, several patches) to solve this
> issue, I can try to have another look and try to understand this, once
> again.

If you're in need of a good practical Debian packaging guide, I highly
recommend Lucas Nussbaum's packaging-tutorial (which you can apt-get
install, or fetch online [1]). Some Python specific packaging tips are
covered on the Debian wiki [2] as well. You're also more than welcome
to drop by #debian-mentors and #debian-python on OFTC if you're still
struggling with packaging-related issues.

Regards,
Vincent

[1] https://www.debian.org/doc/manuals/packaging-tutorial/packaging-tutorial.en.pdf
[2] https://wiki.debian.org/Python/LibraryStyleGuide