diff options
author | David Lawrence <dkl@mozilla.com> | 2014-11-26 16:37:59 +0100 |
---|---|---|
committer | David Lawrence <dkl@mozilla.com> | 2014-11-26 16:37:59 +0100 |
commit | ad031a17fbd31766c4a5d1fe8894178784262d3e (patch) | |
tree | 3d7badd3a23338cbcc3c0e5de66cb29bd3c2eda2 /extensions/Example | |
parent | 649a38910889a9945e2ef22f5d6ff4d32fceeba6 (diff) | |
download | bugzilla-ad031a17fbd31766c4a5d1fe8894178784262d3e.tar.gz bugzilla-ad031a17fbd31766c4a5d1fe8894178784262d3e.tar.xz |
Bug 1038275: Comprehensible documentation for the REST API
r=gerv,a=glob
Diffstat (limited to 'extensions/Example')
-rw-r--r-- | extensions/Example/docs/en/rst/api/v1/index.rst | 4 | ||||
-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`. - |