List Info

Thread: Any interest in making Doxygen the standard doctool for MoinMoin?
Any interest in making Doxygen the standard doctool for MoinMoin?
user name
 2006-04-27 17:39:21 
On 4/27/06, Schwols, Keith C <keith.c.schwolsintel.com> wrote:
> Wouldn't it be good to support writing documentation
in Wiki Markup Language in
> the source python files?  That should provide a simple
mechanism to generate Wiki
> pages of documentation for the MoinMaster wiki (one
wiki page per Moin source
> file.)

Epydoc supports reStructuredText, and so does MoinMoin. 
That's good
enough for me.  


  -Fred

--
Fred L. Drake, Jr.    <fdrake at gmail.com>
"Don't let schooling interfere with your
education." -- Mark Twain


-------------------------------------------------------
Using Tomcat but need to do more? Need to support web
services, security?
Get stuff done quickly with pre-integrated technology to
make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on
Apache Geronimo
http:
//sel.as-us.falkag.net/sel?cmd=lnk&kid0709&bid&
amp;3057&dat1642
_______________________________________________
Moin-user mailing list
Moin-userlists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/moin-user
Any interest in making Doxygen the standard doctool for MoinMoin?
user name
 2006-04-27 19:44:04 

  


  

    
I actually don't care too much what format we use--using the wiki
markup language for documentation would be fine _if_ we could
automatically generate not just code docs, but user docs (i.e.
configuration etc.) from it. reStructuredText would be fine too. I just
want to be able to write, in code, docs that can be generated to tell
other people&nbsp; how to use various options _without_ them needing to go
into the code.



FYI, here are the various commands Doxygen supports. Not all are
relevant to Python (many support C or Java constructs), but many
support general features, such as grouping of doc comments that are far
apart in the codebase, inclusion of documentation from other files, etc.



But like I say, I'm pretty much agnostic on this. I'd just like to be
able to contribute to the dox in a way that makes it likely my
contributions will stay reasonably up to date with future versions.
Often, I find that incorrect documentation is worse than no
documentation at all :-(



 


  
    

      
      
      
      
      

      

      		
    

  






Fred Drake wrote:

mail.gmail.com"
 type="cite">
  
On 4/27/06, Schwols, Keith C intel.com"><keith.c.schwolsintel.com&gt; wrote:
  

  

    
Wouldn't it be good to support writing documentation in Wiki Markup Language in
the source python files?  That should provide a simple mechanism to generate Wiki
pages of documentation for the MoinMaster wiki (one wiki page per Moin source
file.)
    

  

  

Epydoc supports reStructuredText, and so does MoinMoin.  That's good
enough for me.  


  -Fred

--
Fred L. Drake, Jr.    <fdrake at gmail.com&gt;
"Don't let schooling interfere with your education." -- Mark Twain


-------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=k&kid0709&;bid&3057&dat1642
_______________________________________________
Moin-user mailing list
lists.sourceforge.net">Moin-userlists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/moin-user

  






  

  
  
   
     
    






 [1-2]











   
 





about | contact  Other archives ( Real Estate discussion Medical topics )