From 60c57382638c8be81fe6163d1728415c494ad4f8 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Mon, 3 May 2010 18:16:24 -0700 Subject: doc: RDoc 2.5.x updates --- .document | 2 +- GNUmakefile | 14 +++++++++----- README | 3 ++- 3 files changed, 12 insertions(+), 7 deletions(-) diff --git a/.document b/.document index 42b3eea..7ba8cb6 100644 --- a/.document +++ b/.document @@ -4,7 +4,7 @@ FAQ lib LICENSE NEWS -rainbows.1 +rainbows_1 README SIGNALS TODO diff --git a/GNUmakefile b/GNUmakefile index 42c2162..051c4fe 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -24,6 +24,7 @@ tmp/gems/$(RUBY_VERSION)/.isolate: $(ISOLATE_CONFIG) base_bins := rainbows bins := $(addprefix bin/, $(base_bins)) +man1_rdoc := $(addsuffix _1, $(base_bins)) man1_bins := $(addsuffix .1, $(base_bins)) man1_paths := $(addprefix man/man1/, $(man1_bins)) @@ -81,18 +82,21 @@ cgit_atom := http://git.bogomips.org/cgit/rainbows.git/atom/?h=master atom = -# using rdoc 2.4.1+ +# using rdoc 2.5.x+ doc: .document NEWS ChangeLog - for i in $(man1_bins); do > $$i; done + for i in $(man1_rdoc); do echo > $$i; done find bin lib -type f -name '*.rbc' -exec rm -f '{}' ';' - rdoc -Na -t "$(shell sed -ne '1s/^= //p' README)" + rdoc -a -t "$(shell sed -ne '1s/^= //p' README)" install -m644 COPYING doc/COPYING install -m644 $(shell grep '^[A-Z]' .document) doc/ $(MAKE) -C Documentation install-html install-man install -m644 $(man1_paths) doc/ cd doc && for i in $(base_bins); do \ + $(RM) 1.html $${i}.1.html; \ sed -e '/"documentation">/r man1/'$$i'.1.html' \ - < $${i}_1.html > tmp && mv tmp $${i}_1.html; done + < $${i}_1.html > tmp && mv tmp $${i}_1.html; \ + ln $${i}_1.html $${i}.1.html; \ + done $(RUBY) -i -p -e \ '$$_.gsub!("",%q{\&$(call atom,$(cgit_atom))})' \ doc/ChangeLog.html @@ -106,7 +110,7 @@ doc: .document NEWS ChangeLog '$$_.gsub!(/INCLUDE/){File.read("Documentation/comparison.html")}' \ doc/Summary.html cat Documentation/comparison.css >> doc/rdoc.css - $(RM) $(man1_bins) + $(RM) $(man1_rdoc) ifneq ($(VERSION),) rfproject := rainbows diff --git a/README b/README index 7604f9e..21f07d4 100644 --- a/README +++ b/README @@ -123,7 +123,8 @@ config file: worker_connections 100 end -See the {Rainbows! configuration documentation}[link:Rainbows.html#M000001] +See the {Rainbows! configuration}[link:Rainbows.html#method-i-Rainbows!] +{documentation}[link:Rainbows.html#method-i-Rainbows!] for more details. == Development -- cgit v1.2.3-24-ge0c7