1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOC] Load options and parse files from srcdir

Browse Source 
RDoc options that do not change and can be written in `.rdoc_options`
file are moved, so that they match when called without `make`.

Get rid of parsing the files in `page_dir` twice (as relative paths
and absolute paths).
This commit is contained in:
Nobuyoshi Nakada 2024-01-06 20:04:14 +09:00
parent 3dac27897e
commit 9b78ef7552
3 changed files with 28 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.rdoc_options
View File

@ -1,4 +1,7 @@
--- ---
page_dir: doc page_dir: doc
charset: UTF-8
encoding: UTF-8
main_page: README.md main_page: README.md
title: Documentation for Ruby development version title: Documentation for Ruby development version
visibility: :private

10
common.mk
View File

@ -64,14 +64,14 @@ LIBRUBY_EXTS = ./.libruby-with-ext.time
REVISION_H = ./.revision.time REVISION_H = ./.revision.time
PLATFORM_D = $(TIMESTAMPDIR)/.$(PLATFORM_DIR).time PLATFORM_D = $(TIMESTAMPDIR)/.$(PLATFORM_DIR).time
ENC_TRANS_D = $(TIMESTAMPDIR)/.enc-trans.time ENC_TRANS_D = $(TIMESTAMPDIR)/.enc-trans.time
RDOC = $(XRUBY) "$(srcdir)/libexec/rdoc" --root "$(srcdir)" --encoding=UTF-8 --all RDOC = $(XRUBY) "$(tooldir)/rdoc-srcdir"
RDOCOUT = $(EXTOUT)/rdoc RDOCOUT = $(EXTOUT)/rdoc
HTMLOUT = $(EXTOUT)/html HTMLOUT = $(EXTOUT)/html
CAPIOUT = doc/capi CAPIOUT = doc/capi
INSTALL_DOC_OPTS = --rdoc-output="$(RDOCOUT)" --html-output="$(HTMLOUT)" INSTALL_DOC_OPTS = --rdoc-output="$(RDOCOUT)" --html-output="$(HTMLOUT)"
RDOC_GEN_OPTS = --page-dir "$(srcdir)/doc" --no-force-update \ RDOC_GEN_OPTS = --no-force-update \
--title "Documentation for Ruby $(RUBY_API_VERSION)" \ --title "Documentation for Ruby $(RUBY_API_VERSION)" \
--main README.md $(empty)
INITOBJS = dmyext.$(OBJEXT) dmyenc.$(OBJEXT) INITOBJS = dmyext.$(OBJEXT) dmyenc.$(OBJEXT)
NORMALMAINOBJ = main.$(OBJEXT) NORMALMAINOBJ = main.$(OBJEXT)
@ -662,11 +662,11 @@ post-install-dbg::
rdoc: PHONY main srcs-doc rdoc: PHONY main srcs-doc
@echo Generating RDoc documentation @echo Generating RDoc documentation
$(Q) $(RDOC) --ri --op "$(RDOCOUT)" $(RDOC_GEN_OPTS) $(RDOCFLAGS) "$(srcdir)" $(Q) $(RDOC) --ri --op "$(RDOCOUT)" $(RDOC_GEN_OPTS) $(RDOCFLAGS) .
html: PHONY main srcs-doc html: PHONY main srcs-doc
@echo Generating RDoc HTML files @echo Generating RDoc HTML files
$(Q) $(RDOC) --op "$(HTMLOUT)" $(RDOC_GEN_OPTS) $(RDOCFLAGS) "$(srcdir)" $(Q) $(RDOC) --op "$(HTMLOUT)" $(RDOC_GEN_OPTS) $(RDOCFLAGS) .
rdoc-coverage: PHONY main srcs-doc rdoc-coverage: PHONY main srcs-doc
@echo Generating RDoc coverage report @echo Generating RDoc coverage report

20
tool/rdoc-srcdir Normal file
View File

@ -0,0 +1,20 @@
#!ruby
require 'rdoc/rdoc'
# Make only the output directory relative to the invoked directory.
invoked = Dir.pwd
# Load options and parse files from srcdir.
Dir.chdir(File.dirname(__dir__))
options = RDoc::Options.load_options
options.parse ARGV
options.singleton_class.define_method(:finish) do
super()
@op_dir = File.expand_path(@op_dir, invoked)
end
# Do not hide errors when generating documents of Ruby itself.
RDoc::RDoc.new.document options