summaryrefslogtreecommitdiffstats
path: root/template
diff options
context:
space:
mode:
authorGervase Markham <gerv@gerv.net>2015-05-05 15:14:47 +0200
committerGervase Markham <gerv@gerv.net>2015-05-05 15:14:47 +0200
commit2309b684454eaef96d954048411565210eddcf3a (patch)
tree62590bb78cd80de5a5d0b25d2a25c223e3a10bf6 /template
parent88628a5ca0c8af56440d08b09bb088fc337b3c56 (diff)
downloadbugzilla-2309b684454eaef96d954048411565210eddcf3a.tar.gz
bugzilla-2309b684454eaef96d954048411565210eddcf3a.tar.xz
Bug 1159318 - make docs/makedocs.pl and extensions/create.pl agree on the name of docs directories. r=LpSolit, a=glob
Diffstat (limited to 'template')
-rw-r--r--template/en/default/extensions/index-admin.rst.tmpl23
-rw-r--r--template/en/default/extensions/index-user.rst.tmpl23
2 files changed, 46 insertions, 0 deletions
diff --git a/template/en/default/extensions/index-admin.rst.tmpl b/template/en/default/extensions/index-admin.rst.tmpl
new file mode 100644
index 000000000..508937710
--- /dev/null
+++ b/template/en/default/extensions/index-admin.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 Adminstrator 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 Installed Extensions chapter of the Administration Guide.
diff --git a/template/en/default/extensions/index-user.rst.tmpl b/template/en/default/extensions/index-user.rst.tmpl
new file mode 100644
index 000000000..b09fc1cd1
--- /dev/null
+++ b/template/en/default/extensions/index-user.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 User 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 Installed Extensions chapter of the User Guide.