diff --git a/.coveragerc b/.coveragerc index 1d76a1f..ce96e75 100644 --- a/.coveragerc +++ b/.coveragerc @@ -23,4 +23,4 @@ exclude_lines = ignore_errors = True [html] -directory = docs/_build/html/coverage +directory = doc/_build/html/coverage diff --git a/Makefile b/Makefile index e64be1d..d066051 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ # This file has been auto-generated. # All changes will be lost, see Projectfile. # -# Updated at 2016-12-09 05:37:33.079110 +# Updated at 2016-12-09 08:33:52.136641 PYTHON ?= $(shell which python) PYTHON_BASENAME ?= $(shell basename $(PYTHON)) @@ -12,8 +12,12 @@ VIRTUAL_ENV ?= .virtualenv-$(PYTHON_BASENAME) PIP ?= $(VIRTUAL_ENV)/bin/pip PYTEST ?= $(VIRTUAL_ENV)/bin/pytest PYTEST_OPTIONS ?= --capture=no --cov=bonobo --cov-report html +SPHINX_OPTS ?= +SPHINX_BUILD ?= $(VIRTUAL_ENV)/bin/sphinx-build +SPHINX_SOURCEDIR ?= doc +SPHINX_BUILDDIR ?= $(SPHINX_SOURCEDIR)/_build -.PHONY: clean install install-dev lint test +.PHONY: clean doc install install-dev lint test # Installs the local project dependencies. install: $(VIRTUAL_ENV) @@ -43,3 +47,6 @@ lint: install-dev test: install-dev $(PYTEST) $(PYTEST_OPTIONS) tests + +doc: install-dev + $(SPHINX_BUILD) -b html -D latex_paper_size=a4 $(SPHINX_OPTS) $(SPHINX_SOURCEDIR) $(SPHINX_BUILDDIR)/html diff --git a/Projectfile b/Projectfile index ce18634..7da7493 100644 --- a/Projectfile +++ b/Projectfile @@ -12,6 +12,7 @@ author_email = 'romain@dorgueil.net' enable_features = { 'make', + 'sphinx', 'pytest', 'git', 'pylint', diff --git a/docs/Makefile b/doc/Makefile similarity index 100% rename from docs/Makefile rename to doc/Makefile diff --git a/docs/changelog.rst b/doc/changelog.rst similarity index 100% rename from docs/changelog.rst rename to doc/changelog.rst diff --git a/docs/conf.py b/doc/conf.py similarity index 100% rename from docs/conf.py rename to doc/conf.py diff --git a/docs/index.rst b/doc/index.rst similarity index 100% rename from docs/index.rst rename to doc/index.rst diff --git a/docs/make.bat b/doc/make.bat similarity index 100% rename from docs/make.bat rename to doc/make.bat