[Freeipa-devel] [PATCH] jderose 010 improve epydoc generation

[Rob Crittenden]

Jason Gerard DeRose wrote:
> This patch cleans up the ./make-doc script and starts to incorporate it
> into the Makefile.  In summary, it:
>         
>         1. Adds a doc/api/README file
>         
>         2. Cleans up ./make-doc, which now outputs the epydoc pages in
>         doc/api
>         
>         3. Adds a BuildRequires for `epydoc` and `python-docutils` to
>         ipa.spec.in
>         
>         4. Adds a `doc` target in the Makefile
> 
> Rob, when you have time could you incorporate this properly into the
> Makefile and spec file?  Or if you could walk me through the process on
> IRC.  ;)

I discussed this with Simo in #freeipa-devel yesterday and we aren't 
sure that we want to ship the developer documentation. I think that just 
adding the make target is likely enough.

You'll also need to rename the make target. Since there is a 'doc' 
subdirectory already a 'make doc' will report something like 'Nothing to 
be done for doc'. I think you'll need to name the target docs.

And should this be added to the clean target? Also, I think the -f flag 
should be added to the rm command in make-doc when cleaning up before 
re-running epydoc.

rob
-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/x-pkcs7-signature
Size: 3245 bytes
Desc: S/MIME Cryptographic Signature
URL: <http://listman.redhat.com/archives/freeipa-devel/attachments/20090602/4ab8617e/attachment.bin>