Page MenuHomePhabricator

setup: define build_doc command
ClosedPublic

Authored by indygreg on Mar 3 2019, 6:51 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHGd80d48928eb1: setup: define build_doc command
Summary

Currently, various processes for packaging Mercurial state to
manually invoke make -C doc in order to generate the documentation.
This Makefile merely invokes gendoc.py and runrst to produce
man pages and HTML pages.

Not all environments may have the ability to easily run
Makefiles. Windows is notably in this set.

This commit ports the man page and HTML generation logic from
doc/Makefile to setup.py. We introduce a new build_doc command
which generates documentation by calling gendoc.py and runrst.
The documentation can now be built via pure Python by running
python setup.py build_doc.

We don't implement dependency tracking because IMO it is more
effort than it is worth.

We could potentially remove the duplicated functionality in
doc/Makefile. But I'm not sure what all is depending on it. So
I plan to keep it around.

  1. no-check-commit because forced foo_bar function names

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

indygreg created this revision.Mar 3 2019, 6:51 PM
This revision was automatically updated to reflect the committed changes.