mirror of
https://github.com/OfflineIMAP/offlineimap.git
synced 2024-06-30 08:00:55 +02:00
fa0b1ef8ee
The docs still need some meat, but the infrastructure is in place. THis allows us to generate the nice looking API documentation that many python projects already have. We should document our API better, providing an overview of the functionality available. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de> Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
34 lines
803 B
Makefile
34 lines
803 B
Makefile
# This program is free software under the terms of the GNU General Public
|
|
# License. See the COPYING file which must come with this package.
|
|
|
|
SOURCES = $(wildcard *.rst)
|
|
HTML_TARGETS = $(patsubst %.rst,%.html,$(SOURCES))
|
|
|
|
RM = rm
|
|
RST2HTML=`type rst2html >/dev/null 2>&1 && echo rst2html || echo rst2html.py`
|
|
RST2MAN=`type rst2man >/dev/null 2>&1 && echo rst2man || echo rst2man.py`
|
|
SPHINXBUILD = sphinx-build
|
|
|
|
all: html dev-doc
|
|
|
|
html: $(HTML_TARGETS)
|
|
|
|
$(HTML_TARGETS): %.html : %.rst
|
|
$(RST2HTML) $? $@
|
|
|
|
man: offlineimap.1
|
|
|
|
offlineimap.1: MANUAL.rst
|
|
$(RST2MAN) MANUAL.rst offlineimap.1
|
|
cp -f offlineimap.1 ..
|
|
|
|
dev-doc:
|
|
$(SPHINXBUILD) -b html -d dev-doc/doctrees dev-doc-src dev-doc/html
|
|
|
|
clean:
|
|
$(RM) -f $(HTML_TARGETS)
|
|
$(RM) -f offlineimap.1 ../offlineimap.1
|
|
$(RM) -rf dev-doc/*
|
|
|
|
.PHONY: dev-doc
|