Posts

Python Other Documentation Tools

  Other Documentation Tools When considering the state of documentation tools for Python, one should consider what is being done for other systems. This should include tools that work with documentation embedded in source code and tools that work with separated documentation. know more python online training If you can think of additional tools that should be noted, please let me know about them (free or commercial). If you can point to an example of the markup, that would be great; thanks! Source-embedded Documentation JavaDoc -- Perhaps the most widely accepted embedded-source documentation. kdoc -- Yet another implementation of JavaDoc for C++ and IDL; this one is used for the KDE project. LuaDoc -- Variation of JavaDoc used with the Lua embeddable scripting language. POD ("Plain Old Documentation") -- that Perl thing. This can be used either embedded in Perl source or in separate  .pod  files placed alongside the modules being documented. Conversion tools are available wh