Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-02 06:38:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Add a make livehtml target

Browse source
This commit is contained in:
Jon Siwek 2018-12-19 17:25:59 -06:00
parent a80d7ead6c
commit a46967bad8
2 changed files with 9 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

6
Makefile
View file

@ -29,6 +29,10 @@ doc: configured
docclean: configured
$(MAKE) -C $(BUILD) $@
livehtml:
@mkdir -p build/doc/html
sphinx-autobuild --ignore "testing/*" --ignore "*.git/*" --ignore "*.lock" --ignore "*.pyc" --ignore "*.swp" --ignore "*.swpx" --ignore "*.swx" -b html ./doc ./build/doc/html
dist:
@test -e ../$(VERSION_FULL) && rm -ri ../$(VERSION_FULL) || true
@cp -R . ../$(VERSION_FULL)
@ -63,4 +67,4 @@ configured:
@test -d $(BUILD) || ( echo "Error: No build/ directory found. Did you run configure?" && exit 1 )
@test -e $(BUILD)/Makefile || ( echo "Error: No build/Makefile found. Did you run configure?" && exit 1 )
.PHONY : all install clean doc docclean dist distclean configured
.PHONY : all install clean doc docclean dist distclean configured livehtml

4
doc/README
View file

@ -22,3 +22,7 @@ render the reST files into HTML. That target depends on:
* `Read the Docs Sphinx Theme <https://github.com/rtfd/sphinx_rtd_theme>`_
After the build completes, HTML documentation is symlinked in ``build/html``.
There's also a ``make livehtml`` target in the top-level Makefile that
is useful for editing the reST files and seeing changes rendered out live
to a separate HTML browser.