tutor/docs/Makefile

.DEFAULT_GOAL := html
.PHONY: help

build:
	sphinx-build -b html -a -E -n $(BUILD_ARGS) "." "_build/html"

html:
	$(MAKE) build BUILD_ARGS="-W"

browse:
	sensible-browser _build/html/index.html

watch: build browse
	while true; do inotifywait -e modify *.rst */*.rst */*/*.rst ../*.rst conf.py; $(MAKE) build || true; done
Improve documentation 2018-12-26 16:00:47 +01:00			`.DEFAULT_GOAL := html`
Better documentation - More concise table of contents - New intro - Simpler make commands - Fix a couple typos here and there - Get rid of the default github issue template, and start using the template created online. 2019-05-13 16:33:26 +02:00			`.PHONY: help`
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated. 2018-12-03 19:59:09 +01:00
docs: keep running "make watch" on failure 2021-11-23 17:59:14 +01:00			`build:`
			`sphinx-build -b html -a -E -n $(BUILD_ARGS) "." "_build/html"`

Better documentation - More concise table of contents - New intro - Simpler make commands - Fix a couple typos here and there - Get rid of the default github issue template, and start using the template created online. 2019-05-13 16:33:26 +02:00			`html:`
docs: keep running "make watch" on failure 2021-11-23 17:59:14 +01:00			`$(MAKE) build BUILD_ARGS="-W"`
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated. 2018-12-03 19:59:09 +01:00
Improve documentation 2018-12-26 16:00:47 +01:00			`browse:`
			`sensible-browser _build/html/index.html`

docs: keep running "make watch" on failure 2021-11-23 17:59:14 +01:00			`watch: build browse`
			`while true; do inotifywait -e modify .rst /.rst //.rst ../*.rst conf.py; $(MAKE) build \|\| true; done`