Skip to content

Commit

Permalink
Comment linter, test and docs in makefile
Browse files Browse the repository at this point in the history
  • Loading branch information
oldani committed Jan 29, 2017
1 parent 5ef394d commit 05fbed6
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -47,34 +47,34 @@ clean-test: ## remove test and coverage artifacts
rm -f .coverage
rm -fr htmlcov/

lint: ## check style with flake8
flake8 HtmlTestRunner tests
##lint: ## check style with flake8
##flake8 HtmlTestRunner tests

test: ## run tests quickly with the default Python

python setup.py test

test-all: ## run tests on every Python version with tox
tox
##test-all: ## run tests on every Python version with tox
##tox

coverage: ## check code coverage quickly with the default Python
##coverage: ## check code coverage quickly with the default Python

coverage run --source HtmlTestRunner setup.py test
##coverage run --source HtmlTestRunner setup.py test

coverage report -m
coverage html
$(BROWSER) htmlcov/index.html

docs: ## generate Sphinx HTML documentation, including API docs
rm -f docs/HtmlTestRunner.rst
rm -f docs/modules.rst
sphinx-apidoc -o docs/ HtmlTestRunner
$(MAKE) -C docs clean
$(MAKE) -C docs html
$(BROWSER) docs/_build/html/index.html

servedocs: docs ## compile the docs watching for changes
watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
##coverage report -m
##coverage html
##$(BROWSER) htmlcov/index.html

##docs: ## generate Sphinx HTML documentation, including API docs
# rm -f docs/HtmlTestRunner.rst
# rm -f docs/modules.rst
# sphinx-apidoc -o docs/ HtmlTestRunner
# $(MAKE) -C docs clean
# $(MAKE) -C docs html
# $(BROWSER) docs/_build/html/index.html

##servedocs: docs ## compile the docs watching for changes
##watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .

release: clean ## package and upload a release
python setup.py sdist upload
Expand Down

0 comments on commit 05fbed6

Please sign in to comment.