Bureaucrats, confirmed, Administrators
4,558
edits
Changes
Jump to navigation
Jump to search
See The [[CiviCRM]] project, which originally used the Atlassian Confluence Wiki product for documentation, moved over to the (better) '''Read The Docs''' system<ref>https://civicrm.org/blog/michael-mcandrew/a-new-home-for-our-documentation</ref> (based on markdown) in a [https://github.com/civicrm/civicrm-user-guide github repository] and uses the [http://phpdocwww.mkdocs.org/ and MkDocs] (BSD) static site generator tool to publish to their own domain http://docs.civicrm.org/user/en/4.6/ Meanwhile, the [[Drupal]] project has a [https://www.drupal.org/governance/doc-working-group Documentation Working Group] who is using [http://www.methods.co.nz/asciidoc/ AsciiDoc] (GPL) to do the [https://www.wikipediadrupal.org/wikiproject/Javadocuser_guide User Guide] documentation for Drupal 8
Adds examples of what the CiviCRM and Drupal project are using
* [http://svn.wikimedia.org/doc/ MediaWiki Doxygen docs]
== Tools / Generators / Examples ==[http://phpdoc.org/ phpDocumentor ] is the best documentation tool for PHP sources with inspiration from [[wp:Javadoc|JavaDoc]].
The PyDoc tool is used to generate documentation on the language itself, and is also leveraged as a framework for developers of help systems and obviously used to document any classes, and methods of source code.
== Documenting PHP Code ==
