summaryrefslogtreecommitdiffstats
path: root/extensions/Example/docs/en/rst/index-user.rst
diff options
context:
space:
mode:
authorGervase Markham <gerv@gerv.net>2015-01-07 17:01:55 +0100
committerGervase Markham <gerv@gerv.net>2015-01-07 17:01:55 +0100
commit70973ef7f462962c556b6c2a2dc77ff391684992 (patch)
tree480ac16d837f02a15da35d385398df40827f0f9a /extensions/Example/docs/en/rst/index-user.rst
parentaa2bf276dd94fb56d11284eaaa3ec55c1371143b (diff)
downloadbugzilla-70973ef7f462962c556b6c2a2dc77ff391684992.tar.gz
bugzilla-70973ef7f462962c556b6c2a2dc77ff391684992.tar.xz
Bug 1107549 - split extension docs into User and Admin docs. r=dkl, a=glob.
Diffstat (limited to 'extensions/Example/docs/en/rst/index-user.rst')
-rw-r--r--extensions/Example/docs/en/rst/index-user.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/extensions/Example/docs/en/rst/index-user.rst b/extensions/Example/docs/en/rst/index-user.rst
new file mode 100644
index 000000000..a6cbd8309
--- /dev/null
+++ b/extensions/Example/docs/en/rst/index-user.rst
@@ -0,0 +1,12 @@
+Example
+#######
+
+This is a sample User documentation file for the Example 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 User Guide. If you need more than one file's worth of
+user documentation, include others using the Sphinx `toctree
+directive <http://sphinx-doc.org/markup/toctree.html>`_.