[master] 28e6a04f7 Put all generated .rst files in doc/sphinx/include

Poul-Henning Kamp phk at FreeBSD.org
Tue Oct 16 07:35:13 UTC 2018


commit 28e6a04f7aec186a83559668001e13a90444f215
Author: Poul-Henning Kamp <phk at FreeBSD.org>
Date:   Tue Oct 16 07:34:33 2018 +0000

    Put all generated .rst files in doc/sphinx/include

diff --git a/.gitignore b/.gitignore
index 113da821b..c96ca4b91 100644
--- a/.gitignore
+++ b/.gitignore
@@ -82,7 +82,6 @@ cscope.*out
 /man/*.3
 /man/*.7
 /doc/sphinx/include
-/doc/sphinx/*/*generated.rst
 /bin/varnishadm/varnishadm
 /bin/varnishd/varnishd
 /bin/varnishhist/varnishhist
diff --git a/doc/sphinx/Makefile.am b/doc/sphinx/Makefile.am
index cf67a6106..d9be207ac 100644
--- a/doc/sphinx/Makefile.am
+++ b/doc/sphinx/Makefile.am
@@ -212,33 +212,33 @@ include/vtc-syntax.rst: vtc-syntax.py $(VTCSYN_SRC)
 	mv ${@}_ ${@}
 BUILT_SOURCES += include/vtc-syntax.rst
 
-reference/vmod_std.generated.rst: reference $(top_builddir)/lib/libvmod_std/vmod_std.rst
-	cp $(top_builddir)/lib/libvmod_std/vmod_std.rst $@ || true
-BUILT_SOURCES += reference/vmod_std.generated.rst
+include/vmod_std.generated.rst: $(top_builddir)/lib/libvmod_std/vmod_std.rst
+	cp $(top_builddir)/lib/libvmod_std/vmod_std.rst $@
+BUILT_SOURCES += include/vmod_std.generated.rst
 
-reference/vmod_directors.generated.rst: reference $(top_builddir)/lib/libvmod_directors/vmod_directors.rst
-	cp $(top_builddir)/lib/libvmod_directors/vmod_directors.rst $@ || true
-BUILT_SOURCES += reference/vmod_directors.generated.rst
+include/vmod_directors.generated.rst: $(top_builddir)/lib/libvmod_directors/vmod_directors.rst
+	cp $(top_builddir)/lib/libvmod_directors/vmod_directors.rst $@
+BUILT_SOURCES += include/vmod_directors.generated.rst
 
-reference/vmod_purge.generated.rst: reference $(top_builddir)/lib/libvmod_purge/vmod_purge.rst
-	cp $(top_builddir)/lib/libvmod_purge/vmod_purge.rst $@ || true
-BUILT_SOURCES += reference/vmod_purge.generated.rst
+include/vmod_purge.generated.rst: $(top_builddir)/lib/libvmod_purge/vmod_purge.rst
+	cp $(top_builddir)/lib/libvmod_purge/vmod_purge.rst $@
+BUILT_SOURCES += include/vmod_purge.generated.rst
 
-reference/vmod_vtc.generated.rst: reference $(top_builddir)/lib/libvmod_vtc/vmod_vtc.rst
-	cp $(top_builddir)/lib/libvmod_vtc/vmod_vtc.rst $@ || true
-BUILT_SOURCES += reference/vmod_vtc.generated.rst
+include/vmod_vtc.generated.rst: $(top_builddir)/lib/libvmod_vtc/vmod_vtc.rst
+	cp $(top_builddir)/lib/libvmod_vtc/vmod_vtc.rst $@
+BUILT_SOURCES += include/vmod_vtc.generated.rst
 
-reference/vmod_blob.generated.rst: reference $(top_builddir)/lib/libvmod_blob/vmod_blob.rst
-	cp $(top_builddir)/lib/libvmod_blob/vmod_blob.rst $@ || true
-BUILT_SOURCES += reference/vmod_blob.generated.rst
+include/vmod_blob.generated.rst: $(top_builddir)/lib/libvmod_blob/vmod_blob.rst
+	cp $(top_builddir)/lib/libvmod_blob/vmod_blob.rst $@
+BUILT_SOURCES += include/vmod_blob.generated.rst
 
-reference/vmod_unix.generated.rst: reference $(top_builddir)/lib/libvmod_unix/vmod_unix.rst
-	cp $(top_builddir)/lib/libvmod_unix/vmod_unix.rst $@ || true
-BUILT_SOURCES += reference/vmod_unix.generated.rst
+include/vmod_unix.generated.rst: $(top_builddir)/lib/libvmod_unix/vmod_unix.rst
+	cp $(top_builddir)/lib/libvmod_unix/vmod_unix.rst $@
+BUILT_SOURCES += include/vmod_unix.generated.rst
 
-reference/vmod_proxy.generated.rst: reference $(top_builddir)/lib/libvmod_proxy/vmod_proxy.rst
-	cp $(top_builddir)/lib/libvmod_proxy/vmod_proxy.rst $@ || true
-BUILT_SOURCES += reference/vmod_proxy.generated.rst
+include/vmod_proxy.generated.rst: $(top_builddir)/lib/libvmod_proxy/vmod_proxy.rst
+	cp $(top_builddir)/lib/libvmod_proxy/vmod_proxy.rst $@
+BUILT_SOURCES += include/vmod_proxy.generated.rst
 
 EXTRA_DIST += $(BUILT_SOURCES)
 MAINTAINERCLEANFILES = $(EXTRA_DIST)
diff --git a/doc/sphinx/reference/index.rst b/doc/sphinx/reference/index.rst
index 1bf543536..75ec38e99 100644
--- a/doc/sphinx/reference/index.rst
+++ b/doc/sphinx/reference/index.rst
@@ -20,13 +20,7 @@ The Varnish Reference Manual
 	varnishtop.rst
 	vsm.rst
 	vmod.rst
-	vmod_std.generated.rst
-	vmod_directors.generated.rst
-	vmod_vtc.generated.rst
-	vmod_purge.generated.rst
-	vmod_blob.generated.rst
-	vmod_unix.generated.rst
-	vmod_proxy.generated.rst
+	vmod_generated.rst
 	directors.rst
 	varnish-counters.rst
 	vsl.rst
diff --git a/doc/sphinx/reference/vmod_generated.rst b/doc/sphinx/reference/vmod_generated.rst
new file mode 100644
index 000000000..ec89bb9a9
--- /dev/null
+++ b/doc/sphinx/reference/vmod_generated.rst
@@ -0,0 +1,15 @@
+
+.. include::	../include/vmod_std.generated.rst
+
+.. include::	../include/vmod_directors.generated.rst
+
+.. include::	../include/vmod_vtc.generated.rst
+
+.. include::	../include/vmod_purge.generated.rst
+
+.. include::	../include/vmod_blob.generated.rst
+
+.. include::	../include/vmod_unix.generated.rst
+
+.. include::	../include/vmod_proxy.generated.rst
+


More information about the varnish-commit mailing list