aboutsummaryrefslogtreecommitdiffstats
path: root/extensions/Example/docs/en/rst/index-user.rst
diff options
context:
space:
mode:
authorGervase Markham <gerv@gerv.net>2015-01-07 16:02:52 +0000
committerGervase Markham <gerv@gerv.net>2015-01-07 16:02:52 +0000
commit4e15a1338ccc68b44a6fbf26a2c57b46b00df4ce (patch)
treefc110497311895c3bd235ad16ea18167de7b66b9 /extensions/Example/docs/en/rst/index-user.rst
parent40a522aabc8a48f0813c6b69404e466606384db8 (diff)
downloadbugs-4e15a1338ccc68b44a6fbf26a2c57b46b00df4ce.tar
bugs-4e15a1338ccc68b44a6fbf26a2c57b46b00df4ce.tar.gz
bugs-4e15a1338ccc68b44a6fbf26a2c57b46b00df4ce.tar.bz2
bugs-4e15a1338ccc68b44a6fbf26a2c57b46b00df4ce.tar.xz
bugs-4e15a1338ccc68b44a6fbf26a2c57b46b00df4ce.zip
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.rst11
1 files changed, 11 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..192075d10
--- /dev/null
+++ b/extensions/Example/docs/en/rst/index-user.rst
@@ -0,0 +1,11 @@
+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>`_.