From a599d9e8ecd0719456b5bbead1396e51efe3476d Mon Sep 17 00:00:00 2001 From: Arvid Norberg Date: Fri, 17 Oct 2008 17:31:20 +0000 Subject: [PATCH] fixed typos in documentation and made makefile build pdfs with rst2pdf --- docs/makefile | 40 ++++++++++++++++++++++------------------ docs/manual.rst | 1 + docs/python_binding.rst | 4 ++-- 3 files changed, 25 insertions(+), 20 deletions(-) diff --git a/docs/makefile b/docs/makefile index e1e658fb1..8e8e8f2ef 100644 --- a/docs/makefile +++ b/docs/makefile @@ -1,30 +1,34 @@ +# this makefile assumes that you have docutils and rst2pdf installed + WEB_PATH = ~/Documents/rasterbar/web/products/libtorrent DOCUTILS = ~/docutils -TARGETS = index.html \ - udp_tracker_protocol.html \ - projects.html \ - client_test.html \ - manual.html \ - building.html \ - features.html \ - examples.html \ - extension_protocol.html \ - dht_extensions.html \ - libtorrent_plugins.html - -all: $(TARGETS) +TARGETS = index \ + udp_tracker_protocol \ + client_test \ + manual \ + building \ + features \ + examples \ + extension_protocol \ + dht_extensions \ + libtorrent_plugins \ + python_binding \ + projects -%.pdf:%.tex - pdflatex $? +html: $(TARGETS:=.html) -%.tex:%.rst - python $(DOCUTILS)/tools/rst2latex.py $? $@ +pdf: $(TARGETS:=.pdf) + +all: html + +%.pdf:%.rst + rst2pdf $? -o $@ %.html:%.rst python $(DOCUTILS)/tools/rst2html.py --template=template.txt --stylesheet-path=style.css --link-stylesheet --no-toc-backlinks $? > $@ cp $@ $(WEB_PATH)/$@ clean: - rm -f $(TARGETS) round_trip_distribution.log + rm -f $(TARGETS:=.html) $(TARGETS:=.pdf) diff --git a/docs/manual.rst b/docs/manual.rst index 802c3ebda..57fb0ad18 100644 --- a/docs/manual.rst +++ b/docs/manual.rst @@ -219,6 +219,7 @@ pause() resume() is_paused() ---------------------------- :: + void pause(); void resume(); bool is_paused() const; diff --git a/docs/python_binding.rst b/docs/python_binding.rst index 5a61c4a00..7dc512ccd 100644 --- a/docs/python_binding.rst +++ b/docs/python_binding.rst @@ -52,9 +52,9 @@ path used when you installed python as a second option. Like this:: The bindings require *at least* python version 2.2. For more information on how to install and set up boost-build, see the -`building libtorrent`_ section. +`building libtorrent`__ section. -.. _`building libtorrent`: building.html#step-2-setup-bbv2 +.. __: building.html#step-2-setup-bbv2 Once you have boost-build set up, you cd to the ``bindings/python`` directory and invoke ``bjam`` with the apropriate settings. For the available