Mercurial > hg
diff .hgignore @ 52021:2a875530a023
doc: generate separate commands/topics/extension pages
This change modifies gendoc.py and Makefile so that individual pages for
commands, help topics, and extensions can be generated. A new index page is
also generated with links to all these pages. This makes it easier to look up
and search the help text of a given command or topic, instead of having to
deal with the giant hg.1 "all-in-one" page.
Since the list of individual pages varies based on the source code, we generate
a dynamic Makefile that contains this list of files as individual targets.
This gives us fine-grained control over output files. However, it greatly
increases the time spent generating all help pages. It's recommended to run
make with -j to make use of multi-core archs.
Individual man pages are produced in doc/man, and HTML ones are in doc/html
author | Ludovic Chabant <ludovic@chabant.com> |
---|---|
date | Mon, 09 Oct 2023 22:14:24 -0700 |
parents | 59820ae507b1 |
children |
line wrap: on
line diff
--- a/.hgignore Mon Oct 09 22:11:21 2023 -0700 +++ b/.hgignore Mon Oct 09 22:14:24 2023 -0700 @@ -40,10 +40,17 @@ dist packages doc/common.txt +doc/commandlist.txt +doc/extensionlist.txt +doc/topiclist.txt +doc/*.mk doc/*.[0-9] doc/*.[0-9].txt doc/*.[0-9].gendoc.txt doc/*.[0-9].{x,ht}ml +doc/build +doc/html +doc/man MANIFEST MANIFEST.in patches