Merge pull request #57 from AestheticIntegration/feat-documentation-m…

…akefile

Adding a doc target in the Makefile

INSTALL.md

@@ -0,0 +1,48 @@
+## OCaml compilation of the `fix-engine` model 
+
+Build all the `*.cma` libraries in each module subfolder:
+
+```
+make build
+```
+
+Build a FIX server, based on the model:
+
+```
+make server
+```
+
+Build a FIX client that runs the test suite:
+
+```
+make build_test
+```
+
+To run the test suite, you can launch the `run_tests.sh` bash script.
+
+## Making and updating documentation in the `gh-pages`
+
+To update the documentation in the `gh-pages` branch, you can do the following:
+
+- checkout the `master` branch and call maketo generate the `doc` folder
+
+ ```
+ git checkout master  git status
+ make doc
+ ```
+
+- stash the changes in the `doc` folder
+
+```
+git add doc/*
+git stash
+```
+
+- checkout gh-pages and apply the stash    
+
+```
+git checkout gh-pages 
+git checkout stash -- doc
+git commit -m "Update documentation"
+git push origin gh-pages
+```

Makefile

@@ -20,6 +20,17 @@ build_tests:
 	jbuilder build src-tests/test_runner.bc 
 	rm jbuild-ignore
 
+_build/default/_doc:
+	@echo "src-protocol-exts-pp-vg" > jbuild-ignore 
+	@echo "src-protocol-exts-vg" >> jbuild-ignore 
+	jbuilder build @doc
+	rm jbuild-ignore
+
+doc: _build/default/_doc
+	rm -rf doc
+	mv _build/default/_doc doc
+	rm doc/odoc.css
+
 module_graph.svg: _build/doc/all_modules.docdir/all_modules.dot
 	sed -e 's/rotate=90;//g' "$<" | dot -Tsvg -o $@
 
@@ -37,6 +48,7 @@ install-upgrade-deps:
 	opam pin -y add lwt 2.6.0
 	opam install -y jbuilder
 	opam install -y yojson
+	opam install -y odoc
 
 # dev-setup is used by (human) developers
 dev-setup: install-upgrade-deps
@@ -45,5 +57,5 @@ dev-setup: install-upgrade-deps
 clean:
 	jbuilder clean
 
-.PHONY: build build_vgs run run_server clean
+.PHONY: build build_vgs run run_server clean doc