tobias/docker-offlineimap
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2377353cae
docker-offlineimap/docs/Makefile

34 lines
778 B
Makefile
Raw Normal View History

doc: migrate from SGML to restructuredtext This is a great move to help contributors in maintaining documentation. While doing huge changes in this area, do a bit more than simply SGML to rst: * move README from markdown to rst * make a "true" man page with no more information * refactor content and sections Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-01-15 16:48:30 +01:00
# 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
doc: rst2xxx: fix ignoring output while determining the command name Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-03-07 22:23:21 +01:00
RST2HTML=`type rst2html >/dev/null 2>&1 && echo rst2html || echo rst2html.py`
RST2MAN=`type rst2man >/dev/null 2>&1 && echo rst2man || echo rst2man.py`
Add beginnings of sphinx-based code documentation 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>
2011-04-27 10:37:15 +02:00
SPHINXBUILD = sphinx-build
doc: migrate from SGML to restructuredtext This is a great move to help contributors in maintaining documentation. While doing huge changes in this area, do a bit more than simply SGML to rst: * move README from markdown to rst * make a "true" man page with no more information * refactor content and sections Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-01-15 16:48:30 +01:00
Revamped documentation structure and some doc fixes `make` in the `docs` dir or `make doc` in the root dir will now create the 1) man page and 2) the user documentation using sphinx (requiring python-doctools, and sphinx). The resulting user docs are in `docs/html`. You can also only create the man pages with `make man` in the `docs` dir. Also fixed all .rst conversion errors as requested by Gentoo downstream. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-02-24 11:13:27 +01:00
all: man doc
doc: migrate from SGML to restructuredtext This is a great move to help contributors in maintaining documentation. While doing huge changes in this area, do a bit more than simply SGML to rst: * move README from markdown to rst * make a "true" man page with no more information * refactor content and sections Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-01-15 16:48:30 +01:00
html: $(HTML_TARGETS)
$(HTML_TARGETS): %.html : %.rst
Makefile: fix docutils commands call if extension is stripped Looks like some distribution strip the extensions of the python commands and some don't. Try to find the correct commands by ourself. Reported-by: Sebastian Spaeth <Sebastian@SSpaeth.de> Reviewed-by: Sebastian Spaeth <Sebastian@SSpaeth.de> Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-01-27 19:50:24 +01:00
$(RST2HTML) $? $@
doc: migrate from SGML to restructuredtext This is a great move to help contributors in maintaining documentation. While doing huge changes in this area, do a bit more than simply SGML to rst: * move README from markdown to rst * make a "true" man page with no more information * refactor content and sections Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-01-15 16:48:30 +01:00
man: offlineimap.1
offlineimap.1: MANUAL.rst
Makefile: fix docutils commands call if extension is stripped Looks like some distribution strip the extensions of the python commands and some don't. Try to find the correct commands by ourself. Reported-by: Sebastian Spaeth <Sebastian@SSpaeth.de> Reviewed-by: Sebastian Spaeth <Sebastian@SSpaeth.de> Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-01-27 19:50:24 +01:00
$(RST2MAN) MANUAL.rst offlineimap.1
doc: migrate from SGML to restructuredtext This is a great move to help contributors in maintaining documentation. While doing huge changes in this area, do a bit more than simply SGML to rst: * move README from markdown to rst * make a "true" man page with no more information * refactor content and sections Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-01-15 16:48:30 +01:00
cp -f offlineimap.1 ..
Revamped documentation structure and some doc fixes `make` in the `docs` dir or `make doc` in the root dir will now create the 1) man page and 2) the user documentation using sphinx (requiring python-doctools, and sphinx). The resulting user docs are in `docs/html`. You can also only create the man pages with `make man` in the `docs` dir. Also fixed all .rst conversion errors as requested by Gentoo downstream. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-02-24 11:13:27 +01:00
doc:
$(SPHINXBUILD) -b html -d html/doctrees doc-src html
Add beginnings of sphinx-based code documentation 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>
2011-04-27 10:37:15 +02:00
doc: migrate from SGML to restructuredtext This is a great move to help contributors in maintaining documentation. While doing huge changes in this area, do a bit more than simply SGML to rst: * move README from markdown to rst * make a "true" man page with no more information * refactor content and sections Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-01-15 16:48:30 +01:00
clean:
$(RM) -f $(HTML_TARGETS)
$(RM) -f offlineimap.1 ../offlineimap.1
Revamped documentation structure and some doc fixes `make` in the `docs` dir or `make doc` in the root dir will now create the 1) man page and 2) the user documentation using sphinx (requiring python-doctools, and sphinx). The resulting user docs are in `docs/html`. You can also only create the man pages with `make man` in the `docs` dir. Also fixed all .rst conversion errors as requested by Gentoo downstream. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-02-24 11:13:27 +01:00
$(RM) -rf html/*
Add beginnings of sphinx-based code documentation 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>
2011-04-27 10:37:15 +02:00
Revamped documentation structure and some doc fixes `make` in the `docs` dir or `make doc` in the root dir will now create the 1) man page and 2) the user documentation using sphinx (requiring python-doctools, and sphinx). The resulting user docs are in `docs/html`. You can also only create the man pages with `make man` in the `docs` dir. Also fixed all .rst conversion errors as requested by Gentoo downstream. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-02-24 11:13:27 +01:00
.PHONY: clean doc
Reference in New Issue Copy Permalink