aboutsummaryrefslogtreecommitdiffstats
path: root/extensions/Example/doc
diff options
context:
space:
mode:
authorDavid Lawrence <dkl@mozilla.com>2014-11-26 15:43:40 +0000
committerDavid Lawrence <dkl@mozilla.com>2014-11-26 15:43:40 +0000
commitfd1625fa45a5ed604b22a72ef77a7df762fbb7c0 (patch)
tree3086ad9119afacc20eb42e1b627cacd8f533f9bc /extensions/Example/doc
parent45877e03a90ffdd5c21f8a9999375cf14f3aaa12 (diff)
downloadbugs-fd1625fa45a5ed604b22a72ef77a7df762fbb7c0.tar
bugs-fd1625fa45a5ed604b22a72ef77a7df762fbb7c0.tar.gz
bugs-fd1625fa45a5ed604b22a72ef77a7df762fbb7c0.tar.bz2
bugs-fd1625fa45a5ed604b22a72ef77a7df762fbb7c0.tar.xz
bugs-fd1625fa45a5ed604b22a72ef77a7df762fbb7c0.zip
Bug 1038275: Comprehensible documentation for the REST API
r=gerv,a=glob
Diffstat (limited to 'extensions/Example/doc')
-rw-r--r--extensions/Example/doc/example.rst22
1 files changed, 0 insertions, 22 deletions
diff --git a/extensions/Example/doc/example.rst b/extensions/Example/doc/example.rst
deleted file mode 100644
index 07b355887..000000000
--- a/extensions/Example/doc/example.rst
+++ /dev/null
@@ -1,22 +0,0 @@
-Example
-#######
-
-This is a sample 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 Extensions chapter, as will any documentation
-you write for your extensions which fulfils the following criteria:
-
-* In the :file:`extensions/YourExtension/doc/` directory
-* Has a :file:`.rst` file extension
-
-You are recommended to make the name of your reST doc file the same as the
-name of your extension, so that there is no clash when all the extension
-documentation is copied into the same directory. So, for example, this file
-is called :file:`example.rst`, as it's part of the Example extension. If you
-need multiple documentation files, prefix the filename with the name of your
-extension, e.g. :file:`example-extra.rst`.
-