From 34477d3793d308de20711a4df48f7823c91baaba Mon Sep 17 00:00:00 2001 From: Gervase Markham Date: Tue, 25 Feb 2014 12:00:48 +0000 Subject: Bug 963120 - allow extensions to document themselves, and build result into docs. r=LpSolit, a=justdave. --- extensions/Example/doc/example.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 extensions/Example/doc/example.rst (limited to 'extensions/Example') diff --git a/extensions/Example/doc/example.rst b/extensions/Example/doc/example.rst new file mode 100644 index 000000000..07b355887 --- /dev/null +++ b/extensions/Example/doc/example.rst @@ -0,0 +1,22 @@ +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.3-24-g4f1b