From 4e15a1338ccc68b44a6fbf26a2c57b46b00df4ce Mon Sep 17 00:00:00 2001 From: Gervase Markham Date: Wed, 7 Jan 2015 16:02:52 +0000 Subject: Bug 1107549 - split extension docs into User and Admin docs. r=dkl, a=glob. --- Bugzilla/Extension.pm | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'Bugzilla') diff --git a/Bugzilla/Extension.pm b/Bugzilla/Extension.pm index 17193f1b6..e24ceb9eb 100644 --- a/Bugzilla/Extension.pm +++ b/Bugzilla/Extension.pm @@ -651,6 +651,21 @@ So, for example, if you had a CSS file called F and your extension was called F, your file would go into F. +=head2 Documenting Extensions + +Documentation goes in F, if it's in English, or +change "en" to something else if it's not. The user documentation index file +must be called index-user.rst; the admin documentation must be called +index-admin.rst. These will end up in the User Guide and the Administration +Guide respectively. Both documentation types are optional. You can use various +Sphinx constructs such as :toctree: or :include: to include further reST files +if you need more than one page of docs. + +When documenting extensions to the Bugzilla API, if your extension provides +them, the index file would be F. +When and if your API has more than one version, increment the version number. +These docs will get included in the WebService API Reference. + =head2 Disabling Your Extension If you want your extension to be totally ignored by Bugzilla (it will -- cgit v1.2.1