From 2309b684454eaef96d954048411565210eddcf3a Mon Sep 17 00:00:00 2001 From: Gervase Markham Date: Tue, 5 May 2015 14:14:47 +0100 Subject: Bug 1159318 - make docs/makedocs.pl and extensions/create.pl agree on the name of docs directories. r=LpSolit, a=glob --- .../en/default/extensions/index-admin.rst.tmpl | 23 ++++++++++++++++++++++ template/en/default/extensions/index-user.rst.tmpl | 23 ++++++++++++++++++++++ 2 files changed, 46 insertions(+) create mode 100644 template/en/default/extensions/index-admin.rst.tmpl create mode 100644 template/en/default/extensions/index-user.rst.tmpl (limited to 'template/en/default/extensions') 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 `_ +and will be compiled by `Sphinx `_. + +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 `_ +and will be compiled by `Sphinx `_. + +If you build the docs yourself using :file:`makedocs.pl`, this file will get +incorporated into the Installed Extensions chapter of the User Guide. -- cgit v1.2.3-24-g4f1b