37 lines
1.1 KiB
ReStructuredText
37 lines
1.1 KiB
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
|
|
<http://docutils.sourceforge.net/docs/user/rst/quickstart.html>`_ format using
|
|
the `Sphinx <http://www.sphinx-doc.org/>`_ documentation system. It has
|
|
recently been rewritten, so undoubtedly has bugs. Please file bugs on it in
|
|
the `Bugzilla Documentation
|
|
<https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla;component=Documentation>`_
|
|
component. If you want to make a patch, that would be wonderful. Changes are
|
|
best submitted as diffs, attached to a bug. There is a
|
|
:ref:`Style Guide <style-guide>` to help you write any new text and markup.
|
|
|