Provide a documentation package

Bug #725029 reported by David Planella on 2011-02-25
This bug affects 2 people
Affects Status Importance Assigned to Milestone
Quickly Widgets

Bug Description

It would be nice to provide a python-quickly.widgets-doc package containing the API documentation generated from the existing docstring packages.

Sphinx [1] seems to be the tool generally used to build nice Python documentation.

A few pointers for anyone wanting to take up this task:

* An example to look at is the python-apt-doc package, which generates these docs [2].
* I believe the main changes are to add the 'build_sphinx' command to
* Then call it from debian/rules, and add the doc/ folder with a Makefile for Sphinx.
* The python-quickly.widgets should build an additional python-quickly.widgets-doc binary package containing the documentation


To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers