diff --git a/Makefile b/Makefile index 50d5c7c9..c6dd45d4 100644 --- a/Makefile +++ b/Makefile @@ -6,13 +6,15 @@ NOSETESTS=nosetests ICONV=iconv FLAKE8=flake8 FLAKEPLUS=flakeplus +SPHINX2RST=sphinx2rst SPHINX_DIR=docs/ SPHINX_BUILDDIR="${SPHINX_DIR}/_build" README=README.rst README_SRC="docs/templates/readme.txt" -SPHINX2RST="sphinx2rst" -SPHINX_HTMLDIR = "${SPHINX_BUILDDIR}/html" +CONTRIBUTING=CONTRIBUTING.rst +CONTRIBUTING_SRC="docs/contributing.rst" +SPHINX_HTMLDIR="${SPHINX_BUILDDIR}/html" DOCUMENTATION=Documentation FLAKEPLUSTARGET=2.7 @@ -26,11 +28,13 @@ help: @echo " lint ------------ - Check codebase for problems." @echo " apicheck - Check API reference coverage." @echo " configcheck - Check configuration reference coverage." - @echo " readmecheck - Check README encoding." + @echo " readmecheck - Check README.rst encoding." + @echo " contribcheck - Check CONTRIBUTING.rst encoding" @echo " flakes -------- - Check code for syntax and style errors." @echo " flakecheck - Run flake8 on the source code." @echo " flakepluscheck - Run flakeplus on the source code." @echo "readme - Regenerate README.rst file." + @echo "contrib - Regenerate CONTRIBUTING.rst file" @echo "clean-dist --------- - Clean all distribution build artifacts." @echo " clean-git-force - Remove all uncomitted files." @echo " clean ------------ - Non-destructive clean" @@ -80,10 +84,18 @@ readmecheck: $(ICONV) -f ascii -t ascii $(README) >/dev/null $(README): - $(SPHINX2RST) $(README_SRC) --ascii > $@ + $(SPHINX2RST) "$(README_SRC)" --ascii > $@ readme: clean-readme $(README) readmecheck +clean-contrib: + -rm -f "$(CONTRIBUTING)" + +$(CONTRIBUTING): + $(SPHINX2RST) "$(CONTRIBUTING_SRC)" > $@ + +contrib: clean-contrib $(CONTRIBUTING) + clean-pyc: -find . -type f -a \( -name "*.pyc" -o -name "*$$py.class" \) | xargs rm -find . -type d -name "__pycache__" | xargs rm -r @@ -113,4 +125,4 @@ build: distcheck: lint test clean -dist: readme clean-dist build +dist: readme contrib clean-dist build