On Sun, 8 Apr 2001 ed_tsang at yahoo.com wrote: > Hi > > I currently have a bunch of script that I need to write documentation > on. But since the code itself changes during the patches or even > dring the implementation process, I need to constantly checking all > the docuentaiton matches. This is a pain in the ass and it is hard to > maintain .... <...> > Is there any kind of tool to do that? If not, anyone has idea about > how to do it? Maybe have a look at literate programming. In short, intermingle all the docs, code, and textual support files in a single source document (stuff to be extracted as files gets marked up). Tools let you extract the files or pretty print the docs and code. I've used the LyX/noweb combination and a little scripting to build and/or install packages from a single source document (with a single click). emacs also has an LP mode, which I am unfamiliar with. With emacs you get syntax highlighting, with LyX you get a WP like UI, in both cases you are working with LaTeX (convertable to: HTML, PS, PDF, SGML, RTF, TXT, ...) http://www.lyx.org/ http://www.eecs.harvard.edu/~nr/noweb/ - Bruce
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4