Skip to content

Commit

Permalink
Improve documentation generation.
Browse files Browse the repository at this point in the history
  • Loading branch information
mavam committed Jul 17, 2013
1 parent 409e8b9 commit 391e59c
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
4 changes: 2 additions & 2 deletions doc/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -569,7 +569,7 @@ SHOW_USED_FILES = YES
# This will remove the Files entry from the Quick Index and from the
# Folder Tree View (if specified). The default is YES.

SHOW_FILES = YES
SHOW_FILES = NO

# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
# Namespaces page.
Expand Down Expand Up @@ -970,7 +970,7 @@ HTML_COLORSTYLE_GAMMA = 80
# page will contain the date and time when the page was generated. Setting
# this to NO can help when comparing the output of multiple runs.

HTML_TIMESTAMP = YES
HTML_TIMESTAMP = NO

# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
Expand Down
14 changes: 10 additions & 4 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,20 @@ doc: check
doxygen Doxyfile

check: FORCE
test -d gh-pages/api || (git clone $(REPO) gh-pages && git checkout gh-pages)
@test -d gh-pages/api \
|| (git clone $(REPO) gh-pages && git checkout gh-pages)

deploy: doc
@cd gh-pages && git commit -a -e -m 'Update Doxygen API documentation.'
commit: doc
@cd gh-pages \
&& git add api \
&& git commit -a -e -m 'Update Doxygen API documentation.'

deploy: FORCE
@cd gh-pages && git push origin HEAD

update:
doxygen -u Doxyfile

FORCE:

.PHONY: doc check deploy update FORCE
.PHONY: doc check deploy push update FORCE

0 comments on commit 391e59c

Please sign in to comment.