[Yum-devel] documentation!

[Luke Macken]

On Sun, Oct 29, 2006 at 06:48:15PM -0500, seth vidal wrote:
> On Mon, 2006-10-30 at 09:33 +1000, Menno Smits wrote:
> > Luke Macken wrote:
> > > I noticed a while back that Menno mentioned[0] he was going to produce
> > > plugin documentation using epydoc.  I'm not sure what ever came of this,
> > > but I'm interested in generating epydoc for all of yum.
> > 
> > It never happened because Seth said it probably wasn't worthwhile 
> > generating the docs until the API stablised. I guess the API is getting 
> > more stable now so now might be a good time to start.
> 
> I agree with myself from before and with you, now. :)
> 
> we should go ahead and start fluffing on the function docs in 3_0_X

I made some Makefile changes help generate these docs locally.  Let me
know if you want me to commit it.

Also, it might be nice to keep the API docs on the yum homepage as well.
This could be done through a Makefile target that rsyncs them out to the
homepage, or something.

luke

Index: Makefile
===================================================================
RCS file: /home/groups/yum/cvs/yum/Makefile,v
retrieving revision 1.15
diff -u -b -B -r1.15 Makefile
--- Makefile    12 Jul 2006 04:31:05 -0000  1.15
+++ Makefile    30 Oct 2006 17:24:27 -0000
@@ -32,6 +32,13 @@

    for d in $(SUBDIRS); do make PYTHON=$(PYTHON) DESTDIR=`cd $(DESTDIR); pwd` -C $$d install; [ $$? = 0 ] || exit 1; done

+.PHONY: docs
+docs:
+   epydoc -n yum -o docs/epydoc -u http://linux.duke.edu/projects/yum \
+           yum yum-updatesd.py rpmUtils callback.py progress_meter.py \
+           yumcommands.py shell.py translate.py output.py i18n.py cli.py \
+           yummain.py
+
 archive: remove_spec = ${PKGNAME}-daily.spec
 archive: _archive

Index: docs/Makefile
===================================================================
RCS file: /home/groups/yum/cvs/yum/docs/Makefile,v
retrieving revision 1.5
diff -u -b -B -r1.5 Makefile
--- docs/Makefile   27 Jun 2006 20:54:15 -0000  1.5
+++ docs/Makefile   30 Oct 2006 17:24:27 -0000
@@ -3,6 +3,7 @@

 clean:
    rm -f *.pyc *.pyo *~
+   rm -fr epydoc

 install:
    mkdir -p $(DESTDIR)/usr/share/man/man{5,8}