[PATCH 7 of 7] setup: omit manual category in HTML documentation file names

Dan Villiom Podlaski Christiansen danchr at gmail.com
Tue Dec 1 14:33:17 CST 2009


# HG changeset patch
# User Dan Villiom Podlaski Christiansen <danchr at gmail.com>
# Date 1259614485 -3600
# Node ID fd584f300ac64df47ed4b1c0678184792294da9e
# Parent  ad2cffaeaf9295596973b940c43f274aafd42a0a
setup: omit manual category in HTML documentation file names.

The manual category --- e.g. the `5' in hgrc.5 --- is not relevant
when generating the HTML documentation. This tiny change causes the
generated & installed files to be named only e.g. `hgrc.html' rather
than `hgrc.5.html'.

Please note that this may require redirects on servers hosting the
documentation.

diff --git a/setup.py b/setup.py
--- a/setup.py
+++ b/setup.py
@@ -337,8 +337,8 @@ class build_doc(build):
             srcfile = join(build_dir, srcfile)
             # manual file name is e.g. XXX.N
             manfile = join(build_dir, base)
-            # HTML file name is e.g. XXX.N.html
-            htmlfile = join(build_dir, base + '.html')
+            # HTML file name is e.g. XXX.html
+            htmlfile = join(build_dir, name + '.html')
 
             # reader & writer classes
             # NOTE: writers.get_writer_class('manpage') may be used eventually


More information about the Mercurial-devel mailing list