Merge pull request xapi-project#3154 from kc284/master

Extended README.md and excluded from build output.

Author: mseri

Makefile

@@ -14,7 +14,8 @@ doc: setup.data build
 	$(SETUP) -doc $(DOCFLAGS)
 	./jsapi.native -destdir _build/ocaml/doc -templdir ocaml/doc/templates
 	./datamodel_main.native -closed -markdown -templdir ocaml/doc/templates _build/ocaml/doc/markdown
-	cp ocaml/doc/*.dot ocaml/doc/*.md ocaml/doc/doc-convert.sh _build/ocaml/doc/markdown
+	cp ocaml/doc/*.dot ocaml/doc/doc-convert.sh _build/ocaml/doc/markdown
+	find ocaml/doc -name "*.md" -not -name "README.md" -exec cp {} _build/ocaml/doc/markdown/ \;
 
 test: setup.data build
 	$(SETUP) -test $(TESTFLAGS)

ocaml/doc/README.md

@@ -3,9 +3,12 @@
 Run `make doc`. The output is in `_build/ocaml/doc/markdown`.
 
 To view the markdown properly you will need to install `graphviz` so as to
-convert the dot files to images. To generate a pdf in addition, you will need to
-install `pandoc` and `pdflatex`.
+convert the dot files to images. To generate the API reference in other formats
+(currently docbook and pdf) you will need to install `pandoc`. For pdf format
+you will also need `pdflatex`.
 
 To convert the images only, run `sh doc-convert.sh`.
 
-To also generate the pdf run `sh doc-convert.sh --pdf`.
+To generate the docbook run `sh doc-convert.sh --docbook`.
+
+To generate the pdf run `sh doc-convert.sh --pdf`.