]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commit
admin/build-doc: add livehtml target
authorKefu Chai <kchai@redhat.com>
Fri, 11 Dec 2020 13:33:41 +0000 (21:33 +0800)
committerKefu Chai <kchai@redhat.com>
Fri, 11 Dec 2020 14:30:56 +0000 (22:30 +0800)
commit34f74e8a376a528efff5e0a1c530834c2ba02e92
tree7dd96512f5b145cc0232ee6a13c9cbe8ee6d5805
parent4d6d1465ea6d593953564c8119048e10475b4e9c
admin/build-doc: add livehtml target

it is time-consuming to rebuild the python bindings every time we
rebuild the document, it'd be ideal if we could just build document.

in this change, in addition to "html" and "doc", "livehtml" argument is
now supported by build-doc script, so one can just use

./build-doc livehtml

to build and start a web server. whenever a change in doc/ is detected,
the document is rebuilt. for more details, see
https://pypi.org/project/sphinx-autobuild/

Signed-off-by: Kefu Chai <kchai@redhat.com>
admin/build-doc
doc/dev/generatedocs.rst