Skip to content

Commit

Permalink
Makefile: Consolidate documentation targets, and add "htmlclean"
Browse files Browse the repository at this point in the history
* removed docs and docs-only targets

* apidoc       : generate apidoc

* htmldoc-only : build apidoc, build html

* htmldoc      : build apidoc, build html and open in browser

* htmlclean    : remove documentation build artifacts
  • Loading branch information
jcfr committed Nov 11, 2017
1 parent b17bbdf commit 5b65cdf
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,20 @@ test_docker:

apidoc:
cd docs && $(MAKE) apidoc
@echo ""
@echo "To view the PDF documentation open: docs/_build/html/index.html"

htmldoc:
htmldoc-only: apidoc
cd docs && $(MAKE) html
@echo ""
@echo "To view the PDF documentation open: docs/_build/html/index.html"

docs-only: htmldoc
htmlclean:
cd docs && $(MAKE) clean

docs: docs-only
htmldoc-open:
@echo ""
@echo "To view the HTML documentation open: docs/_build/html/index.html"
open docs/_build/html/index.html || xdg-open docs/_build/html/index.html

htmldoc: htmldoc-only htmldoc-open

pdfdoc:
cd docs && $(MAKE) latexpdf
@echo ""
Expand Down

0 comments on commit 5b65cdf

Please sign in to comment.