aboutsummaryrefslogtreecommitdiffstats
path: root/template/en/default
diff options
context:
space:
mode:
authorGervase Markham <gerv@gerv.net>2014-02-25 12:00:48 +0000
committerGervase Markham <gerv@mozilla.org>2014-02-25 12:00:48 +0000
commit34477d3793d308de20711a4df48f7823c91baaba (patch)
tree28da01ac0931a0f5858e9a793fa1a32f975a723c /template/en/default
parentef925d6942a3462a9c1d52406a6145b5e31faefb (diff)
downloadbugs-34477d3793d308de20711a4df48f7823c91baaba.tar
bugs-34477d3793d308de20711a4df48f7823c91baaba.tar.gz
bugs-34477d3793d308de20711a4df48f7823c91baaba.tar.bz2
bugs-34477d3793d308de20711a4df48f7823c91baaba.tar.xz
bugs-34477d3793d308de20711a4df48f7823c91baaba.zip
Bug 963120 - allow extensions to document themselves, and build result into docs. r=LpSolit, a=justdave.
Diffstat (limited to 'template/en/default')
-rw-r--r--template/en/default/extensions/name.rst.tmpl23
1 files changed, 23 insertions, 0 deletions
diff --git a/template/en/default/extensions/name.rst.tmpl b/template/en/default/extensions/name.rst.tmpl
new file mode 100644
index 000000000..c2e1b5a80
--- /dev/null
+++ b/template/en/default/extensions/name.rst.tmpl
@@ -0,0 +1,23 @@
+[%# This Source Code Form is subject to the terms of the Mozilla Public
+ # License, v. 2.0. If a copy of the MPL was not distributed with this
+ # file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ #
+ # This Source Code Form is "Incompatible With Secondary Licenses", as
+ # defined by the Mozilla Public License, v. 2.0.
+ #%]
+
+[%# INTERFACE:
+ # name: string; the name of the extension.
+ #%]
+
+[% USE String('#') %]
+[% name %]
+[%+ String.repeat(name.length) %]
+
+This is a sample documentation file for the [% name %] extension. Like all of
+the Bugzilla docs, it's written in
+`reStructured Text (reST) format <http://sphinx-doc.org/latest/rest.html>`_
+and will be compiled by `Sphinx <http://sphinx-doc.org/>`_.
+
+If you build the docs yourself using :file:`makedocs.pl`, this file will get
+incorporated into the Extensions chapter.