aboutsummaryrefslogtreecommitdiffstats
path: root/extensions
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
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')
-rw-r--r--extensions/Example/docs/en/rst/api/v1/index.rst4
-rw-r--r--extensions/Example/docs/en/rst/example.rst (renamed from extensions/Example/doc/example.rst)1
2 files changed, 4 insertions, 1 deletions
diff --git a/extensions/Example/docs/en/rst/api/v1/index.rst b/extensions/Example/docs/en/rst/api/v1/index.rst
new file mode 100644
index 000000000..02186bb0b
--- /dev/null
+++ b/extensions/Example/docs/en/rst/api/v1/index.rst
@@ -0,0 +1,4 @@
+Example API v1
+==============
+
+Here is where you place your API docs for the Example extension.
diff --git a/extensions/Example/doc/example.rst b/extensions/Example/docs/en/rst/example.rst
index 07b355887..f2c055bae 100644
--- a/extensions/Example/doc/example.rst
+++ b/extensions/Example/docs/en/rst/example.rst
@@ -19,4 +19,3 @@ 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`.
-