tutor/docs/Makefile

.DEFAULT_GOAL := html
.PHONY: help

html:
	sphinx-build -b html -a -E "." "_build/html"

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

watch: html browse
	while true; do inotifywait -e modify *.rst */*.rst */*/*.rst ../*.rst conf.py; $(MAKE) html; done
Improve documentation 2018-12-26 15:00:47 +00: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 14:33:26 +00: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 18:59:09 +00:00
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 14:33:26 +00:00			`html:`
			`sphinx-build -b html -a -E "." "_build/html"`
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 18:59:09 +00:00
Improve documentation 2018-12-26 15:00:47 +00:00			`browse:`
			`sensible-browser _build/html/index.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 14:33:26 +00:00			`watch: html browse`
docs: generate reference docs automatically This is performed with the help of sphinx-click: https://sphinx-click.readthedocs.io 2021-09-16 09:39:26 +00:00			`while true; do inotifywait -e modify .rst /.rst //.rst ../*.rst conf.py; $(MAKE) html; done`