diff options
| author | Fred Drake <fdrake@acm.org> | 2001-01-09 22:02:10 (GMT) |
|---|---|---|
| committer | Fred Drake <fdrake@acm.org> | 2001-01-09 22:02:10 (GMT) |
| commit | 42181dba8ecf9736ae0ec2384aa4307533c835e1 (patch) | |
| tree | 957090d36ed7fea73d8aff5a392c80bcb5fe25f5 | |
| parent | e07d5cf9663c69d4656249df65543fdca7d6966c (diff) | |
| download | cpython-42181dba8ecf9736ae0ec2384aa4307533c835e1.zip cpython-42181dba8ecf9736ae0ec2384aa4307533c835e1.tar.gz cpython-42181dba8ecf9736ae0ec2384aa4307533c835e1.tar.bz2 | |
Added a --global-module-index option to specify a (possibly relative) URL
to the Global Module Index for a set of documents. This is used to include
a reference to the global index from the per-document module indexes, so
that it is just a little easier to find.
(Someone suggested this, but I do not remember who. Please let me know if
it was you -- thanks!)
| -rw-r--r-- | Doc/html/Makefile | 3 | ||||
| -rw-r--r-- | Doc/perl/l2hinit.perl | 10 | ||||
| -rwxr-xr-x | Doc/tools/mkhowto | 7 |
3 files changed, 18 insertions, 2 deletions
diff --git a/Doc/html/Makefile b/Doc/html/Makefile index 6b2827b..5da7cab 100644 --- a/Doc/html/Makefile +++ b/Doc/html/Makefile @@ -14,7 +14,8 @@ PYTHON= python WEBCHECKER=$(PYTHON) $(TOPDIR)/../Tools/webchecker/webchecker.py MKHOWTO= $(TOOLSDIR)/mkhowto --about $(TOPDIR)/html/stdabout.dat \ --address $(PYTHONDOCS) --up-link ../index.html \ - --up-title "Python Documentation Index" + --up-title "Python Documentation Index" \ + --global-module-index "../modindex.html" MKHTML= $(MKHOWTO) --html BUILDINDEX=$(TOOLSDIR)/buildindex.py diff --git a/Doc/perl/l2hinit.perl b/Doc/perl/l2hinit.perl index 4ffcc58..d3720d9 100644 --- a/Doc/perl/l2hinit.perl +++ b/Doc/perl/l2hinit.perl @@ -332,6 +332,16 @@ sub add_module_idx { . "<tt class='module'>$key</tt>$plat###\n"; } close(MODIDXFILE); + + if ($GLOBAL_MODULE_INDEX) { + $prefix = <<MODULE_INDEX_PREFIX; + +<p> This index only lists modules documented in this manual. + The <em class="citetitle"><a href="$GLOBAL_MODULE_INDEX">Global Module + Index</a></em> lists all modules that are documented in this set + of manuals.</p> +MODULE_INDEX_PREFIX + } if (!$allthesame) { $prefix .= <<PLAT_DISCUSS; diff --git a/Doc/tools/mkhowto b/Doc/tools/mkhowto index 0cb788f..e832f9a 100755 --- a/Doc/tools/mkhowto +++ b/Doc/tools/mkhowto @@ -91,6 +91,7 @@ class Options: quiet = 0 runs = 0 numeric = 0 + global_module_index = None style_file = os.path.join(TOPDIR, "html", "style.css") about_file = os.path.join(TOPDIR, "html", "about.dat") up_link = None @@ -117,7 +118,8 @@ class Options: "link=", "split=", "logging", "debugging", "keep", "quiet", "runs=", "image-type=", "about=", "numeric", "style=", - "up-link=", "up-title="] + "up-link=", "up-title=", + "global-module-index="] + list(self.ALL_FORMATS)) for opt, arg in opts: if opt == "--all": @@ -163,6 +165,8 @@ class Options: self.up_link = arg elif opt == "--up-title": self.up_title = arg + elif opt == "--global-module-index": + self.global_module_index = arg # # Format specifiers: # @@ -405,6 +409,7 @@ class Job: l2hoption(fp, "MAX_SPLIT_DEPTH", options.max_split_depth) l2hoption(fp, "EXTERNAL_UP_LINK", options.up_link) l2hoption(fp, "EXTERNAL_UP_TITLE", options.up_title) + l2hoption(fp, "GLOBAL_MODULE_INDEX", options.global_module_index) fp.write("1;\n") fp.close() |