Confirmed users
1,927
edits
Auto-tools/Projects/MozBase: Difference between revisions
m
→Documentation
(→Documentation: Added bullet point about full docs. Removed obsolete reference to docs manifest and MDN) |
m (→Documentation) |
||
| Line 256: | Line 256: | ||
* basic 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]. | * basic 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]. | ||
* full docs are found in the [https://github.com/mozilla/mozbase/tree/master/docs top-level docs directory] and hosted at [http://mozbase.readthedocs.org]. We're always looking for help [[Auto-tools/Projects/MozBase/WritingDocs|writing docs]]. | * full docs are found in the [https://github.com/mozilla/mozbase/tree/master/docs top-level docs directory] and hosted at [http://mozbase.readthedocs.org http://mozbase.readthedocs.org]. We're always looking for help [[Auto-tools/Projects/MozBase/WritingDocs|writing docs]]. | ||
* 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 ) | ||