From fd1625fa45a5ed604b22a72ef77a7df762fbb7c0 Mon Sep 17 00:00:00 2001 From: David Lawrence Date: Wed, 26 Nov 2014 15:43:40 +0000 Subject: Bug 1038275: Comprehensible documentation for the REST API r=gerv,a=glob --- extensions/Example/doc/example.rst | 22 ---------------------- 1 file changed, 22 deletions(-) delete mode 100644 extensions/Example/doc/example.rst (limited to 'extensions/Example/doc') 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 `_ -and will be compiled by `Sphinx `_. - -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`. - -- cgit v1.2.1