IL2HorusTeam/il2fb-commons

View on GitHub
docs/Makefile

Summary

Maintainability
Test Coverage
SPHINXOPTS    =
SPHINXBUILD   = sphinx-build
BUILDDIR      = _build

# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif

# Internal variables.
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(SPHINXOPTS) .

.PHONY: help clean html dirhtml singlehtml sphinx-apidoc

help:
    @echo "Please use \`make <target>' where <target> is one of"
    @echo "  html          to make standalone HTML files"
    @echo "  dirhtml       to make HTML files named index.html in directories"
    @echo "  singlehtml    to make a single large HTML file"
    @echo "  sphinx-apidoc to generate API docs"

clean:
    rm -rf $(BUILDDIR)/*

html: sphinx-apidoc
    $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
    @echo
    @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

dirhtml: sphinx-apidoc
    $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
    @echo
    @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

singlehtml: sphinx-apidoc
    $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
    @echo
    @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

sphinx-apidoc:
    rm -f ./il2fb-commons.rst
    sphinx-apidoc --implicit-namespaces -o . ../il2fb
    rm -f ./modules.rst