32 lines
835 B
ReStructuredText
32 lines
835 B
ReStructuredText
.. _conventions:
|
|
|
|
Document Conventions
|
|
####################
|
|
|
|
This document uses the following conventions:
|
|
|
|
.. warning:: This is a warning - something you should be aware of.
|
|
|
|
.. note:: This is just a note, for your information.
|
|
|
|
A filename or a path to a filename is displayed like this:
|
|
:file:`/path/to/filename.ext`
|
|
|
|
A command to type in the shell is displayed like this:
|
|
:command:`command --arguments`
|
|
|
|
A sample of code is illustrated like this:
|
|
|
|
::
|
|
|
|
First Line of Code
|
|
Second Line of Code
|
|
...
|
|
|
|
This documentation is maintained in reStructured Text format using the
|
|
`Sphinx <http://www.sphinx-doc.org/>`_ documentation system.
|
|
Changes are best submitted as diffs, attached
|
|
to a bug filed in the `Bugzilla Documentation <https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla;component=Documentation>`_
|
|
component.
|
|
|