Question:
software for creating documentation?
2011-08-01 02:19:04 UTC
Hello!
Does anyone know a good piece of software for creating documentation (with search field, content, liks etc)?
I'm looking for a tool that could help automatically create sites like this: http://download.oracle.com/javase/6/docs/api/index.html
(but not the one that generates docs from comments in code, just one that helps to edit single pages and then connect them)
Thanks in advance
Three answers:
Peter H
2011-08-01 02:35:05 UTC
There are a number of programs for doing this, but the ones I looked at were quite expensive. Google "help file generator' for a list.

If you want a web page format you could also consider an HTML page generator, many of which come for free.
kenzo2047
2011-08-01 06:35:08 UTC
The site you point to is created using javadoc, a standard component of the jdk that produces documentation from properly configured comments and markups in your java code.



Even though I am not a big fan of documentation produced by developers, this is still an easy way to produce it with minimal cost. If your code is in java, then you should still consider this approach. It is also the expected way for documenting java classes. Note that a similar tool exists for Javascript.
Eli
2011-08-01 08:31:33 UTC
and this one is for python



http://sourceforge.net/projects/epydoc/


This content was originally posted on Y! Answers, a Q&A website that shut down in 2021.
Loading...