This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9989

gendoc: add support for loading extensions from config settings
ClosedPublic

Authored by spectral on Feb 12 2021, 3:05 PM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHGeb36f7a71291: gendoc: add support for loading extensions from config settings
Summary

We manage our installation and ship some extensions, enabled by default for our
users, that are in hgext3rd or other directories not scanned by this tool by
default. We want to generate docs during the build process, and having those
docs include the extensions that users don't have to manually enable is
desirable.

This is *not* desirable for the normal build process, however, and should never
be enabled by default.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

spectral created this revision.Feb 12 2021, 3:05 PM
pulkit accepted this revision.Feb 14 2021, 10:16 AM
This revision is now accepted and ready to land.Feb 14 2021, 10:16 AM

Revision Contents
Changeset List

PathPackages
Mdoc/gendoc.py (5 lines)

Diff 25622

doc/gendoc.py

if __name__ == "__main__": if __name__ == "__main__":
doc = b'hg.1.gendoc' doc = b'hg.1.gendoc'
if len(sys.argv) > 1: if len(sys.argv) > 1:
doc = encoding.strtolocal(sys.argv[1]) doc = encoding.strtolocal(sys.argv[1])
ui = uimod.ui.load() ui = uimod.ui.load()
# Trigger extensions to load. This is disabled by default because it uses
# the current user's configuration, which is often not what is wanted.
if encoding.environ.get(b'GENDOC_LOAD_CONFIGURED_EXTENSIONS', b'0') != b'0':
extensions.loadall(ui)
if doc == b'hg.1.gendoc': if doc == b'hg.1.gendoc':
showdoc(ui) showdoc(ui)
else: else:
showtopic(ui, encoding.strtolocal(sys.argv[1])) showtopic(ui, encoding.strtolocal(sys.argv[1]))