Software Documentation: Difference between revisions
No edit summary |
Adds examples of what the CiviCRM and Drupal project are using |
||
| Line 21: | Line 21: | ||
* [http://svn.wikimedia.org/doc/ MediaWiki Doxygen docs] | * [http://svn.wikimedia.org/doc/ MediaWiki Doxygen docs] | ||
== Tools / Generators == | == Tools / Generators / Examples == | ||
phpDocumentor is the best documentation tool for PHP sources with inspiration from JavaDoc. | [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. | 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. | ||
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://www.mkdocs.org/ 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.drupal.org/project/user_guide User Guide] documentation for Drupal 8 | |||
== Documenting PHP Code == | == Documenting PHP Code == | ||