From 34477d3793d308de20711a4df48f7823c91baaba Mon Sep 17 00:00:00 2001 From: Gervase Markham Date: Tue, 25 Feb 2014 12:00:48 +0000 Subject: Bug 963120 - allow extensions to document themselves, and build result into docs. r=LpSolit, a=justdave. --- template/en/default/extensions/name.rst.tmpl | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 template/en/default/extensions/name.rst.tmpl (limited to 'template/en') 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 `_ +and will be compiled by `Sphinx `_. + +If you build the docs yourself using :file:`makedocs.pl`, this file will get +incorporated into the Extensions chapter. -- cgit v1.2.3-24-g4f1b