947
edits
Auto-tools/Projects/MozBase: Difference between revisions
Jump to navigation
Jump to search
Auto-tools/Projects/MozBase (view source)
Revision as of 23:46, 11 September 2012
, 11 September 2012→Documentation: minor updates
(→Tests: minor updates) |
(→Documentation: minor updates) |
||
| Line 238: | Line 238: | ||
=== Documentation === | === Documentation === | ||
* documentation should be in a 'README.md' file each package's base directory. The documentation is done in [http://daringfireball.net/projects/markdown/ markdown] syntax so that the it is automatically rendered in the package index presentation on [https://github.com/ github]. | * documentation should be in a 'README.md' file in each package's base directory. The documentation is done in [http://daringfireball.net/projects/markdown/ markdown] syntax so that the it is automatically rendered in the package index presentation on [https://github.com/ github]. | ||
* the README.md is included as the `long_description` in each `setup.py` file so that the documentation may be presented (albeit, unrendered) on [http://pypi.python.org/pypi the Python Package Index]. (Example: https://github.com/mozilla/mozbase/blob/master/mozprofile/setup.py ) | * the README.md is included as the `long_description` in each `setup.py` file so that the documentation may be presented (albeit, unrendered) on [http://pypi.python.org/pypi the Python Package Index]. (''Example'': https://github.com/mozilla/mozbase/blob/master/mozprofile/setup.py ) | ||
* [http://k0s.org/mozilla/hg/DocumentIt/ DocumentIt] is used in conjunction with [https://github.com/mozilla/mozbase/blob/master/docs.manifest a manifest] to update documentation on [https://developer.mozilla.org the Mozilla Developer Network (MDN)]. (''TODO'': figure out how to take updates from MDN in a semi-automatic way.) | * [http://k0s.org/mozilla/hg/DocumentIt/ DocumentIt] is used in conjunction with [https://github.com/mozilla/mozbase/blob/master/docs.manifest a manifest] to update documentation on [https://developer.mozilla.org the Mozilla Developer Network (MDN)]. (''TODO'': figure out how to take updates from MDN in a semi-automatic way. Also, since switching to kuma, these documents cannot be mirrored with DocumentIt currently. Don't even try.) | ||
* [https://wiki.mozilla.org/Auto-tools/Projects/MozBase this page] is the MozBase project page that gives information for core MozBase Developers. Documentation may move to and from this page and the various README files | * [https://wiki.mozilla.org/Auto-tools/Projects/MozBase this page] is the MozBase project page that gives information for core MozBase Developers and about the project itself. Documentation may move to and from this page and the various README files | ||
=== Installing MozBase for Development === | === Installing MozBase for Development === | ||