[Xapian-tickets] [Xapian] #138: HTML API docs for python bindings (was: Tidy up output of epydoc when processing xapian python bindings)

[Xapian]

#138: HTML API docs for python bindings
--------------------------------------+------------------------------
 Reporter:  richard                   |             Owner:  richard
     Type:  enhancement               |            Status:  assigned
 Priority:  low                       |         Milestone:  1.3.3
Component:  Xapian-bindings (Python)  |           Version:  SVN trunk
 Severity:  minor                     |        Resolution:
 Keywords:                            |        Blocked By:
 Blocking:                            |  Operating System:  All
--------------------------------------+------------------------------
\
\
\
\
Changes (by olly):

 * milestone:  1.3.x => 1.3.3

\
\
\

Comment:

 James also suggested sphinx on IRC (and pdoc, but that seems fairly new
 and to have already petered out).  Retitling, since this isn't really
 about epydoc now.

 Getting some docs with sphinx is very easy:

 {{{
 #!sh
 $ cd xapian-bindings/python
 $ sphinx-apidoc -F -o sphinx-doc xapian
 $ make -C sphinx-doc html
 $ iceweasel sphinx-doc/_build/html/index.html
 }}}

 Looking at the output it clearly needs more work to get something nice to
 actually use.  Not sure how the output from the above compares to the
 epydoc output.

 It would be good to have something online, even if it's not totally
 perfect, so setting for milestone:1.3.3.  Even the output from the above
 probably beats not having anything.
\
\
\

--
Ticket URL: <http://trac.xapian.org/ticket/138#comment:19>
Xapian <http://xapian.org/>
Xapian