3

I'm wondering if there is a more generic tool than TeXdoc to browse (and generate) documentation. With TeXdoc, one retrieves (as far as I know) the documentation .pdf of the package. This requires that the developer generates such .pdf and furthermore some of these files are not structured to find the specifications for a macro easily.

Java however has a specific syntax to document methods (macros in LaTeX) such that an IDE can show documentation on the fly and web/pdf documentation can be generated automatically based on the javadoc annotations.

Is there a package/tool to document a package one has developed such that other programs (IDE's, browsers) can use this information?

  • 2
    You can also read books with texdoc You should probably also have a look at clsguide. I think a package is devoted to the writing of documentation, but cannot find its name. – Clément Jul 23 '14 at 20:05
  • 1
    You mean the doc package? – Martin Schröder Jul 24 '14 at 17:09
  • @MartinSchröder: not exactly. The documentation should be placed in the same file as where the macros are defined. And then a postprocessor can generate documentation. – Willem Van Onsem Nov 16 '14 at 11:07
  • @CommuSoft: Look up dtx/doc. Literate programming was invented for TeX. – Martin Schröder Nov 16 '14 at 11:46

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Browse other questions tagged or ask your own question.