Skip to content
This repository has been archived by the owner on Jan 5, 2021. It is now read-only.

Commit

Permalink
Add convinience commands to update the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
loicteixeira committed Aug 14, 2017
1 parent b0ad3d4 commit 689bd69
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.PHONY: help doc_generate doc_publish doc_serve
.DEFAULT_GOAL := help

help: ## See what commands are available.
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36mmake %-15s\033[0m # %s\n", $$1, $$2}'

doc_generate: ## Build documentation. Make sure `doxygen` is in the $PATH (e.g. `ln -s /Applications/Doxygen.app/Contents/Resources/doxygen /usr/local/bin/doxygen`).
pushd ./Documentation/; doxygen ./Doxyfile; popd;

doc_publish: ## Publish the generated documentation to `gh-pages`.
git push origin `git subtree split --prefix Documentation/Output/html master`:gh-pages --force

doc_serve: ## Serve the generated documentation on `http://localhost:8000`
pushd ./Documentation/Output/html; python2 -m SimpleHTTPServer 8000; popd;

0 comments on commit 689bd69

Please sign in to comment.