[mirror_ovs.git] / Documentation / automake.mk

EXTRA_DIST += \
	Documentation/group-selection-method-property.txt \
	Documentation/_static/logo.png \
	Documentation/_static/overview.png \
	Documentation/conf.py \
	Documentation/index.rst \
	Documentation/contents.rst \
	Documentation/intro/index.rst \
	Documentation/intro/what-is-ovs.rst \
	Documentation/intro/why-ovs.rst \
	Documentation/intro/install/index.rst \
	Documentation/intro/install/bash-completion.rst \
	Documentation/intro/install/debian.rst \
	Documentation/intro/install/documentation.rst \
	Documentation/intro/install/dpdk.rst \
	Documentation/intro/install/fedora.rst \
	Documentation/intro/install/general.rst \
	Documentation/intro/install/netbsd.rst \
	Documentation/intro/install/rhel.rst \
	Documentation/intro/install/userspace.rst \
	Documentation/intro/install/windows.rst \
	Documentation/intro/install/xenserver.rst \
	Documentation/tutorials/index.rst \
	Documentation/tutorials/ovn-basics.rst \
	Documentation/tutorials/ovs-advanced.rst \
	Documentation/topics/index.rst \
	Documentation/topics/bonding.rst \
	Documentation/topics/datapath.rst \
	Documentation/topics/design.rst \
	Documentation/topics/dpdk/index.rst \
	Documentation/topics/dpdk/vhost-user.rst \
	Documentation/topics/testing.rst \
	Documentation/topics/high-availability.rst \
	Documentation/topics/integration.rst \
	Documentation/topics/language-bindings.rst \
	Documentation/topics/openflow.rst \
	Documentation/topics/ovsdb-replication.rst \
	Documentation/topics/porting.rst \
	Documentation/topics/windows.rst \
	Documentation/howto/index.rst \
	Documentation/howto/docker.rst \
	Documentation/howto/dpdk.rst \
	Documentation/howto/kvm.rst \
	Documentation/howto/libvirt.rst \
	Documentation/howto/selinux.rst \
	Documentation/howto/ssl.rst \
	Documentation/howto/lisp.rst \
	Documentation/howto/openstack-containers.rst \
	Documentation/howto/qos.png \
	Documentation/howto/qos.rst \
	Documentation/howto/sflow.png \
	Documentation/howto/sflow.rst \
	Documentation/howto/tunneling.png \
	Documentation/howto/tunneling.rst \
	Documentation/howto/userspace-tunneling.rst \
	Documentation/howto/vlan.png \
	Documentation/howto/vlan.rst \
	Documentation/howto/vtep.rst \
	Documentation/ref/index.rst \
	Documentation/faq/index.rst \
	Documentation/faq/configuration.rst \
	Documentation/faq/contributing.rst \
	Documentation/faq/design.rst \
	Documentation/faq/general.rst \
	Documentation/faq/issues.rst \
	Documentation/faq/openflow.rst \
	Documentation/faq/qos.rst \
	Documentation/faq/releases.rst \
	Documentation/faq/terminology.rst \
	Documentation/faq/vlan.rst \
	Documentation/faq/vxlan.rst \
	Documentation/internals/index.rst \
	Documentation/internals/authors.rst \
	Documentation/internals/bugs.rst \
	Documentation/internals/committer-grant-revocation.rst \
	Documentation/internals/committer-responsibilities.rst \
	Documentation/internals/mailing-lists.rst \
	Documentation/internals/maintainers.rst \
	Documentation/internals/patchwork.rst \
	Documentation/internals/release-process.rst \
	Documentation/internals/security.rst \
	Documentation/internals/contributing/index.rst \
	Documentation/internals/contributing/coding-style.rst \
	Documentation/internals/contributing/coding-style-windows.rst \
	Documentation/internals/contributing/documentation-style.rst \
	Documentation/internals/contributing/libopenvswitch-abi.rst \
	Documentation/internals/contributing/submitting-patches.rst \
	Documentation/requirements.txt

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXSRCDIR = $(srcdir)/Documentation
SPHINXBUILDDIR = $(builddir)/Documentation/_build

# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -W -n -d $(SPHINXBUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SPHINXSRCDIR)

sphinx_verbose = $(sphinx_verbose_@AM_V@)
sphinx_verbose_ = $(sphinx_verbose_@AM_DEFAULT_V@)
sphinx_verbose_0 = -q

if HAVE_SPHINX
htmldocs:
	$(AM_V_GEN)$(SPHINXBUILD) $(sphinx_verbose) -b html $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/html
ALL_LOCAL += htmldocs

check-docs:
	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/linkcheck

clean-docs:
	rm -rf $(SPHINXBUILDDIR)/doctrees
	rm -rf $(SPHINXBUILDDIR)/html
	rm -rf $(SPHINXBUILDDIR)/linkcheck
CLEAN_LOCAL += clean-docs
endif
.PHONY: htmldocs
.PHONY: check-docs
.PHONY: clean-docs
Commit	Line	Data
daf5079e	1	EXTRA_DIST += \
c431227e	2	Documentation/group-selection-method-property.txt \
daf5079e	3	Documentation/_static/logo.png \
2eaf6a08	4	Documentation/_static/overview.png \
daf5079e SF	5	Documentation/conf.py \
daf5079e SF	6	Documentation/index.rst \
11820a1f SF	7	Documentation/contents.rst \
11820a1f SF	8	Documentation/intro/index.rst \
2eaf6a08	9	Documentation/intro/what-is-ovs.rst \
3c8a3b31	10	Documentation/intro/why-ovs.rst \
11820a1f	11	Documentation/intro/install/index.rst \
795752a3 SF	12	Documentation/intro/install/bash-completion.rst \
795752a3 SF	13	Documentation/intro/install/debian.rst \
73c76b44	14	Documentation/intro/install/documentation.rst \
795752a3 SF	15	Documentation/intro/install/dpdk.rst \
	16	Documentation/intro/install/fedora.rst \
	17	Documentation/intro/install/general.rst \
	18	Documentation/intro/install/netbsd.rst \
	19	Documentation/intro/install/rhel.rst \
	20	Documentation/intro/install/userspace.rst \
	21	Documentation/intro/install/windows.rst \
	22	Documentation/intro/install/xenserver.rst \
11820a1f	23	Documentation/tutorials/index.rst \
e12569bb SF	24	Documentation/tutorials/ovn-basics.rst \
e12569bb SF	25	Documentation/tutorials/ovs-advanced.rst \
11820a1f	26	Documentation/topics/index.rst \
7c9afefd SF	27	Documentation/topics/bonding.rst \
	28	Documentation/topics/datapath.rst \
	29	Documentation/topics/design.rst \
e69e4f5b SF	30	Documentation/topics/dpdk/index.rst \
e69e4f5b SF	31	Documentation/topics/dpdk/vhost-user.rst \
e69e4f5b	32	Documentation/topics/testing.rst \
7c9afefd SF	33	Documentation/topics/high-availability.rst \
7c9afefd SF	34	Documentation/topics/integration.rst \
f150a8ba	35	Documentation/topics/language-bindings.rst \
7c9afefd SF	36	Documentation/topics/openflow.rst \
	37	Documentation/topics/ovsdb-replication.rst \
	38	Documentation/topics/porting.rst \
	39	Documentation/topics/windows.rst \
11820a1f	40	Documentation/howto/index.rst \
795752a3	41	Documentation/howto/docker.rst \
e69e4f5b	42	Documentation/howto/dpdk.rst \
795752a3 SF	43	Documentation/howto/kvm.rst \
	44	Documentation/howto/libvirt.rst \
	45	Documentation/howto/selinux.rst \
	46	Documentation/howto/ssl.rst \
43f317ff SF	47	Documentation/howto/lisp.rst \
43f317ff SF	48	Documentation/howto/openstack-containers.rst \
b0bef8d1 SF	49	Documentation/howto/qos.png \
b0bef8d1 SF	50	Documentation/howto/qos.rst \
198c5d3d SF	51	Documentation/howto/sflow.png \
198c5d3d SF	52	Documentation/howto/sflow.rst \
4643d687 SF	53	Documentation/howto/tunneling.png \
4643d687 SF	54	Documentation/howto/tunneling.rst \
b438493e	55	Documentation/howto/userspace-tunneling.rst \
e37319ea SF	56	Documentation/howto/vlan.png \
e37319ea SF	57	Documentation/howto/vlan.rst \
43f317ff	58	Documentation/howto/vtep.rst \
11820a1f SF	59	Documentation/ref/index.rst \
11820a1f SF	60	Documentation/faq/index.rst \
11e02906 SF	61	Documentation/faq/configuration.rst \
	62	Documentation/faq/contributing.rst \
	63	Documentation/faq/design.rst \
	64	Documentation/faq/general.rst \
	65	Documentation/faq/issues.rst \
	66	Documentation/faq/openflow.rst \
	67	Documentation/faq/qos.rst \
	68	Documentation/faq/releases.rst \
	69	Documentation/faq/terminology.rst \
	70	Documentation/faq/vlan.rst \
	71	Documentation/faq/vxlan.rst \
d0e53b15 SF	72	Documentation/internals/index.rst \
	73	Documentation/internals/authors.rst \
	74	Documentation/internals/bugs.rst \
	75	Documentation/internals/committer-grant-revocation.rst \
	76	Documentation/internals/committer-responsibilities.rst \
	77	Documentation/internals/mailing-lists.rst \
	78	Documentation/internals/maintainers.rst \
3c2604f7	79	Documentation/internals/patchwork.rst \
d0e53b15 SF	80	Documentation/internals/release-process.rst \
	81	Documentation/internals/security.rst \
	82	Documentation/internals/contributing/index.rst \
	83	Documentation/internals/contributing/coding-style.rst \
	84	Documentation/internals/contributing/coding-style-windows.rst \
	85	Documentation/internals/contributing/documentation-style.rst \
cb991590	86	Documentation/internals/contributing/libopenvswitch-abi.rst \
73c76b44 SF	87	Documentation/internals/contributing/submitting-patches.rst \
73c76b44 SF	88	Documentation/requirements.txt
daf5079e SF	89
	90	# You can set these variables from the command line.
	91	SPHINXOPTS =
	92	SPHINXBUILD = sphinx-build
	93	SPHINXSRCDIR = $(srcdir)/Documentation
c431227e	94	SPHINXBUILDDIR = $(builddir)/Documentation/_build
daf5079e SF	95
	96	# Internal variables.
	97	PAPEROPT_a4 = -D latex_paper_size=a4
	98	PAPEROPT_letter = -D latex_paper_size=letter
099cf485	99	ALLSPHINXOPTS = -W -n -d $(SPHINXBUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SPHINXSRCDIR)
daf5079e	100
099cf485 SF	101	sphinx_verbose = $(sphinx_verbose_@AM_V@)
	102	sphinx_verbose_ = $(sphinx_verbose_@AM_DEFAULT_V@)
	103	sphinx_verbose_0 = -q
d84bdc82 SF	104
d84bdc82 SF	105	if HAVE_SPHINX
daf5079e	106	htmldocs:
099cf485 SF	107	$(AM_V_GEN)$(SPHINXBUILD) $(sphinx_verbose) -b html $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/html
099cf485 SF	108	ALL_LOCAL += htmldocs
099cf485 SF	109
	110	check-docs:
	111	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/linkcheck
f93f0e4a SF	112
	113	clean-docs:
	114	rm -rf $(SPHINXBUILDDIR)/doctrees
	115	rm -rf $(SPHINXBUILDDIR)/html
	116	rm -rf $(SPHINXBUILDDIR)/linkcheck
	117	CLEAN_LOCAL += clean-docs
d84bdc82 SF	118	endif
	119	.PHONY: htmldocs
	120	.PHONY: check-docs
f93f0e4a	121	.PHONY: clean-docs