premiere-libtorrent/docs/makefile

# this makefile assumes that you have docutils and rst2pdf installed

WEB_PATH = ~/Documents/rasterbar/web/products/libtorrent

REFERENCE_TARGETS = \
	reference \
	reference-Session \
	reference-Core \
	reference-String \
	reference-Plugins \
	reference-Create_Torrents \
	reference-Error_Codes \
	reference-Time \
	reference-Storage \
	reference-Custom_Storage \
	reference-Utility \
	reference-Bencoding \
	reference-Alerts \
	reference-RSS \
	reference-Filter \
	reference-Settings \
	manual-ref

TARGETS = index \
	udp_tracker_protocol \
	dht_rss \
	dht_store \
	client_test \
	building \
	features \
	troubleshooting \
	contributing\
	examples \
	extension_protocol \
	dht_extensions \
	dht_sec \
	python_binding \
	projects \
	utp \
	tuning \
	hacking \
	streaming \
	$(REFERENCE_TARGETS)

FIGURES = read_disk_buffers write_disk_buffers troubleshooting

html: $(TARGETS:=.html) $(FIGURES:=.png) todo.html 

pdf: $(TARGETS:=.pdf) $(FIGURES:=.eps)

epub: $(TARGETS:=.epub) $(FIGURES:=.png)

all: html

settings.rst: ../include/libtorrent/settings_pack.hpp
	python gen_settings_doc.py

stats_counters.rst: ../src/session_stats.cpp ../include/libtorrent/performance_counters.hpp
	python gen_stats_doc.py

manual.rst: stats_counters.rst
	touch manual.rst

troubleshooting_thumb.png: troubleshooting.png
	convert troubleshooting.png -resize 800x800 troubleshooting_thumb.png
	cp $@ $(WEB_PATH)/$@

troubleshooting.png: troubleshooting.dot
	dot troubleshooting.dot -Tpng >troubleshooting.png
	cp $@ $(WEB_PATH)/$@

todo.html:gen_todo.py ../src/*.cpp ../include/libtorrent/*.hpp
	python gen_todo.py
	cp $@ $(WEB_PATH)/$@

$(REFERENCE_TARGETS:=.rst):gen_reference_doc.py ../include/libtorrent/*.hpp ../include/libtorrent/kademlia/*.hpp manual.rst settings.rst session_stats.rst
	python gen_reference_doc.py

%.epub:%.rst
	rst2epub $? $@

%.pdf:%.rst
	rst2pdf $? -o $@ --stylesheets stylesheet

%.html:%.rst
	rst2html.py --template=template.txt --stylesheet-path=style.css --link-stylesheet --no-toc-backlinks $? > $@
	rst2html.py --template=template2.txt --stylesheet-path=style.css --link-stylesheet --no-toc-backlinks $? > $(WEB_PATH)/$@

%.png:%.dot
	dot -Tpng $? >$@
	cp $@ $(WEB_PATH)/$@

%.eps:%.dot
	dot -Teps $? >$@
	cp $@ $(WEB_PATH)/$@

clean:
	rm -f $(TARGETS:=.html) $(TARGETS:=.pdf) settings.rst todo.html reference*.html reference*.rst
fixed typos in documentation and made makefile build pdfs with rst2pdf 2008-10-17 19:31:20 +02:00			`# this makefile assumes that you have docutils and rst2pdf installed`

regenerated documentation. added makefile for docs, added rst template file 2008-10-17 05:23:30 +02:00			`WEB_PATH = ~/Documents/rasterbar/web/products/libtorrent`

automatically generate links in reference documentation for symbols (classes, enums, enum values, functions and member functions) 2013-08-05 07:26:15 +02:00			`REFERENCE_TARGETS = \`
			`reference \`
move some defines from headers to cpp files (to improve ABI stability). add some documentation. regenerate html. minor fixes to documentation script 2013-12-19 06:35:47 +01:00			`reference-Session \`
automatically generate links in reference documentation for symbols (classes, enums, enum values, functions and member functions) 2013-08-05 07:26:15 +02:00			`reference-Core \`
			`reference-String \`
			`reference-Plugins \`
			`reference-Create_Torrents \`
			`reference-Error_Codes \`
			`reference-Time \`
			`reference-Storage \`
			`reference-Custom_Storage \`
			`reference-Utility \`
			`reference-Bencoding \`
			`reference-Alerts \`
			`reference-RSS \`
move torrent_handle documentation into header file 2013-08-06 04:50:57 +02:00			`reference-Filter \`
more documentation polishing. the manual.rst is now also linked to the reference documentation 2013-08-11 18:57:33 +02:00			`reference-Settings \`
			`manual-ref`
automatically generate links in reference documentation for symbols (classes, enums, enum values, functions and member functions) 2013-08-05 07:26:15 +02:00
fixed typos in documentation and made makefile build pdfs with rst2pdf 2008-10-17 19:31:20 +02:00			`TARGETS = index \`
			`udp_tracker_protocol \`
add DHT extension proposal document 2011-01-02 04:53:28 +01:00			`dht_rss \`
add support for mutable put/get functions in DHT 2011-05-25 04:26:07 +02:00			`dht_store \`
fixed typos in documentation and made makefile build pdfs with rst2pdf 2008-10-17 19:31:20 +02:00			`client_test \`
			`building \`
			`features \`
advertize troubleshooting chart on front-page 2014-02-02 10:57:24 +01:00			`troubleshooting \`
regenerated html and added contribution page 2010-02-18 21:01:23 +01:00			`contributing\`
fixed typos in documentation and made makefile build pdfs with rst2pdf 2008-10-17 19:31:20 +02:00			`examples \`
			`extension_protocol \`
			`dht_extensions \`
first implementation of DHT security implementation. tie the node ID to the external IP 2010-12-11 10:38:07 +01:00			`dht_sec \`
fixed typos in documentation and made makefile build pdfs with rst2pdf 2008-10-17 19:31:20 +02:00			`python_binding \`
documentation update 2009-02-09 04:48:27 +01:00			`projects \`
merged uTP branch into trunk (yay) 2010-11-29 02:33:05 +01:00			`utp \`
add some documentation of the internals of libtorrent 2011-12-11 10:44:05 +01:00			`tuning \`
generate rst instead of html for reference documentation. This allows for RST markup in comments 2013-07-24 07:04:46 +02:00			`hacking \`
add documentation on streaming implementation 2014-06-07 18:43:14 +02:00			`streaming \`
automatically generate links in reference documentation for symbols (classes, enums, enum values, functions and member functions) 2013-08-05 07:26:15 +02:00			`$(REFERENCE_TARGETS)`
fixed typos in documentation and made makefile build pdfs with rst2pdf 2008-10-17 19:31:20 +02:00
added early version of trouble shooting guide 2011-03-13 19:19:09 +01:00			`FIGURES = read_disk_buffers write_disk_buffers troubleshooting`
fixed typos in documentation and made makefile build pdfs with rst2pdf 2008-10-17 19:31:20 +02:00
generate rst instead of html for reference documentation. This allows for RST markup in comments 2013-07-24 07:04:46 +02:00			`html: $(TARGETS:=.html) $(FIGURES:=.png) todo.html`
documentation update 2009-02-09 04:48:27 +01:00
			`pdf: $(TARGETS:=.pdf) $(FIGURES:=.eps)`
fixed typos in documentation and made makefile build pdfs with rst2pdf 2008-10-17 19:31:20 +02:00
add epub target for documentation makefile 2012-12-31 07:51:04 +01:00			`epub: $(TARGETS:=.epub) $(FIGURES:=.png)`

fixed typos in documentation and made makefile build pdfs with rst2pdf 2008-10-17 19:31:20 +02:00			`all: html`

land libtorrent_aio branch in trunk 2014-07-06 21:18:00 +02:00			`settings.rst: ../include/libtorrent/settings_pack.hpp`
			`python gen_settings_doc.py`

fix docs generation for stats counters 2014-07-30 04:00:14 +02:00			`stats_counters.rst: ../src/session_stats.cpp ../include/libtorrent/performance_counters.hpp`
restore gen_stats_docs.py 2014-07-09 01:44:34 +02:00			`python gen_stats_doc.py`
land libtorrent_aio branch in trunk 2014-07-06 21:18:00 +02:00
restore gen_stats_docs.py 2014-07-09 01:44:34 +02:00			`manual.rst: stats_counters.rst`
land libtorrent_aio branch in trunk 2014-07-06 21:18:00 +02:00			`touch manual.rst`

fix doc makefile 2014-02-02 11:02:51 +01:00			`troubleshooting_thumb.png: troubleshooting.png`
			`convert troubleshooting.png -resize 800x800 troubleshooting_thumb.png`
merged changes from RC_1_0 2014-07-10 18:23:47 +02:00			`cp $@ $(WEB_PATH)/$@`
fix doc makefile 2014-02-02 11:02:51 +01:00
			`troubleshooting.png: troubleshooting.dot`
			`dot troubleshooting.dot -Tpng >troubleshooting.png`
merged changes from RC_1_0 2014-07-10 18:23:47 +02:00			`cp $@ $(WEB_PATH)/$@`
fix doc makefile 2014-02-02 11:02:51 +01:00
clean up the root directory by moving parsing scripts into the tools directory 2013-06-14 18:49:06 +02:00			`todo.html:gen_todo.py ../src/.cpp ../include/libtorrent/.hpp`
			`python gen_todo.py`
merged changes from RC_1_0 2014-07-10 18:23:47 +02:00			`cp $@ $(WEB_PATH)/$@`
clean up the root directory by moving parsing scripts into the tools directory 2013-06-14 18:49:06 +02:00
restore gen_stats_docs.py 2014-07-09 01:44:34 +02:00			`$(REFERENCE_TARGETS:=.rst):gen_reference_doc.py ../include/libtorrent/.hpp ../include/libtorrent/kademlia/.hpp manual.rst settings.rst session_stats.rst`
add script to extract reference documentation from headers 2013-07-19 18:29:53 +02:00			`python gen_reference_doc.py`

add epub target for documentation makefile 2012-12-31 07:51:04 +01:00			`%.epub:%.rst`
			`rst2epub $? $@`

fixed typos in documentation and made makefile build pdfs with rst2pdf 2008-10-17 19:31:20 +02:00			`%.pdf:%.rst`
updated docs makefile and added rst2pdf stylesheet 2008-10-22 02:55:51 +02:00			`rst2pdf $? -o $@ --stylesheets stylesheet`
regenerated documentation. added makefile for docs, added rst template file 2008-10-17 05:23:30 +02:00
			`%.html:%.rst`
documentation fixes, and remove debug dependency on file_pool structure layout 2014-05-26 03:02:26 +02:00			`rst2html.py --template=template.txt --stylesheet-path=style.css --link-stylesheet --no-toc-backlinks $? > $@`
			`rst2html.py --template=template2.txt --stylesheet-path=style.css --link-stylesheet --no-toc-backlinks $? > $(WEB_PATH)/$@`
regenerated documentation. added makefile for docs, added rst template file 2008-10-17 05:23:30 +02:00
added early version of trouble shooting guide 2011-03-13 19:19:09 +01:00			`%.png:%.dot`
			`dot -Tpng $? >$@`
			`cp $@ $(WEB_PATH)/$@`

documentation update 2009-02-09 04:48:27 +01:00			`%.eps:%.dot`
			`dot -Teps $? >$@`
			`cp $@ $(WEB_PATH)/$@`

regenerated documentation. added makefile for docs, added rst template file 2008-10-17 05:23:30 +02:00			`clean:`
land libtorrent_aio branch in trunk 2014-07-06 21:18:00 +02:00			`rm -f $(TARGETS:=.html) $(TARGETS:=.pdf) settings.rst todo.html reference.html reference.rst`
regenerated documentation. added makefile for docs, added rst template file 2008-10-17 05:23:30 +02:00