diff options
| author | David Lamparter <equinox@opensourcerouting.org> | 2018-08-15 22:59:31 +0200 | 
|---|---|---|
| committer | David Lamparter <equinox@opensourcerouting.org> | 2018-08-30 08:06:44 +0200 | 
| commit | 9e53b31551844a02b3bb2bd359f0a389eddf0d50 (patch) | |
| tree | b29f9f300e5658b7db8dc8d4e684e0f062c5040f /doc/user/subdir.am | |
| parent | f177317a20ff417c2dc9d719f2e1135d81ff96f8 (diff) | |
build: non-recursive doc + parallel sphinx
Sphinx actually does work with a parallel build, if the doctree creation
is a separate step (which the other builds will then just read
unmodified.)  This can be done with the "dummy" target.
This also adds "-j6" to sphinx-build and adds a "--disable-doc-html"
switch on ./configure to turn on/off building HTML docs separately.
Also, HTML docs are now installed by "make install" to
/usr/share/doc/frr/html.
Signed-off-by: David Lamparter <equinox@diac24.net>
Diffstat (limited to 'doc/user/subdir.am')
| -rw-r--r-- | doc/user/subdir.am | 110 | 
1 files changed, 110 insertions, 0 deletions
diff --git a/doc/user/subdir.am b/doc/user/subdir.am new file mode 100644 index 0000000000..6e51eed9d1 --- /dev/null +++ b/doc/user/subdir.am @@ -0,0 +1,110 @@ +# +# doc/user +# + +user_RSTFILES = \ +	doc/user/babeld.rst \ +	doc/user/ldpd.rst \ +	doc/user/basic.rst \ +	doc/user/bgp.rst \ +	doc/user/bugs.rst \ +	doc/user/conf.py \ +	doc/user/eigrpd.rst \ +	doc/user/filter.rst \ +	doc/user/glossary.rst \ +	doc/user/index.rst \ +	doc/user/installation.rst \ +	doc/user/ipv6.rst \ +	doc/user/isisd.rst \ +	doc/user/kernel.rst \ +	doc/user/nhrpd.rst \ +	doc/user/ospf6d.rst \ +	doc/user/ospfd.rst \ +	doc/user/ospf_fundamentals.rst \ +	doc/user/overview.rst \ +	doc/user/packet-dumps.rst \ +	doc/user/pim.rst \ +	doc/user/ripd.rst \ +	doc/user/pbr.rst \ +	doc/user/ripngd.rst \ +	doc/user/routemap.rst \ +	doc/user/routeserver.rst \ +	doc/user/rpki.rst \ +	doc/user/setup.rst \ +	doc/user/sharp.rst \ +	doc/user/snmp.rst \ +	doc/user/snmptrap.rst \ +	doc/user/static.rst \ +	doc/user/vnc.rst \ +	doc/user/vtysh.rst \ +	doc/user/zebra.rst \ +	doc/user/bfd.rst \ +	doc/user/flowspec.rst \ +	# end + +EXTRA_DIST += \ +	$(user_RSTFILES) \ +	doc/user/Useful_Sysctl_Settings.md \ +	# end + +USERBUILD = doc/user/_build +$(USERBUILD)/.doctrees/environment.pickle: $(user_RSTFILES) + +# +# automake integration (things that should be built in "all") +# + +if DOC +nodist_noinst_DATA += $(USERBUILD)/texinfo/frr.info +endif +if DOC_HTML +nodist_noinst_DATA += $(USERBUILD)/html/.buildinfo +endif + +# +# standard targets +# + +.PHONY: info html pdf +info: $(USERBUILD)/texinfo/frr.info +html: $(USERBUILD)/html/.buildinfo +pdf:  $(USERBUILD)/latexpdf + +# +# hook-ins for clean / install / doc +# + +.PHONY: clean-userdocs +clean-local: clean-userdocs +clean-userdocs: +	-rm -rf "$(USERBUILD)" + +# INSTALL_INFO=install-info +.PHONY: install-info uninstall-info install-html uninstall-html + +install-info: $(USERBUILD)/texinfo/frr.info +	$(MKDIR_P) "$(DESTDIR)$(infodir)" +	$(INSTALL_DATA) "$<" "$(DESTDIR)$(infodir)" +	[ -z "${DESTDIR}" ] && $(INSTALL_INFO) --info-dir="$(DESTDIR)$(infodir)" "$<" || true +uninstall-info: $(USERBUILD)/texinfo/frr.info +	-rm -f "$(DESTDIR)$(infodir)/$<" +	[ -z "${DESTDIR}" ] && $(INSTALL_INFO) --delete --info-dir="$(DESTDIR)$(infodir)" "$<" || true + +install-html: $(USERBUILD)/html/.buildinfo +	$(MKDIR_P) "$(DESTDIR)$(htmldir)" +	cp -r "$(USERBUILD)/html" "$(DESTDIR)$(htmldir)" +uninstall-html: +	-rm -rf "$(DESTDIR)$(htmldir)/html" + +.PHONY: install-data-local uninstall-local +if DOC +DOC_INFO=info +install-data-local: install-info +uninstall-local:  uninstall-info +endif +if DOC_HTML +DOC_HTML=html +install-data-local: install-html +uninstall-local:  uninstall-html +endif +doc: $(DOC_INFO) $(DOC_HTML)  | 
