[master] 57a46f0 Put vmod docs back into the documentation.

Lasse Karstensen lkarsten at varnish-software.com
Tue May 13 14:08:41 CEST 2014


commit 57a46f0229a4fbbb328a9cbbcb76da750e394c66
Author: Lasse Karstensen <lkarsten at varnish-software.com>
Date:   Tue May 13 13:54:15 2014 +0200

    Put vmod docs back into the documentation.
    
    Squashing Sphinx warnings revealed that the vmod_std and
    vmod_directors includes wasn't working.
    
    Move the generated files a bit so Sphinx is happy to load them.
    
    I'm not using include (where relative paths seem to work)
    since that works differently in a TOC listing.

diff --git a/.gitignore b/.gitignore
index ba64e39..b4ae99b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -80,6 +80,7 @@ cscope.*out
 /man/*.3
 /man/*.7
 /doc/sphinx/include
+/doc/sphinx/*/*generated.rst
 /bin/varnish*/varnish*_opt2rst
 /bin/varnishadm/varnishadm
 /bin/varnishd/varnishd
diff --git a/doc/sphinx/Makefile.am b/doc/sphinx/Makefile.am
index ab8d021..0219fac 100644
--- a/doc/sphinx/Makefile.am
+++ b/doc/sphinx/Makefile.am
@@ -213,13 +213,13 @@ include/varnishhist_synopsis.rst: $(top_builddir)/bin/varnishhist/varnishhist_op
 BUILT_SOURCES += include/varnishhist_options.rst \
 	 include/varnishhist_synopsis.rst
 
-include/vmod_std.rst: $(top_builddir)/lib/libvmod_std/vmod_std.rst
+reference/vmod_std.generated.rst: $(top_builddir)/lib/libvmod_std/vmod_std.rst
 	cp $? $@
-BUILT_SOURCES += include/vmod_std.rst
+BUILT_SOURCES += reference/vmod_std.generated.rst
 
-include/vmod_directors.rst: $(top_builddir)/lib/libvmod_directors/vmod_directors.rst
+reference/vmod_directors.generated.rst: $(top_builddir)/lib/libvmod_directors/vmod_directors.rst
 	cp $? $@
-BUILT_SOURCES += include/vmod_directors.rst
+BUILT_SOURCES += reference/vmod_directors.generated.rst
 
 EXTRA_DIST += $(BUILT_SOURCES)
 MAINTAINERCLEANFILES = $(EXTRA_DIST)
diff --git a/doc/sphinx/reference/index.rst b/doc/sphinx/reference/index.rst
index 20ac975..32458a6 100644
--- a/doc/sphinx/reference/index.rst
+++ b/doc/sphinx/reference/index.rst
@@ -21,8 +21,8 @@ The Varnish Reference Manual
 	varnishtop.rst
 	vsm.rst
 	vmod.rst
-	../include/vmod_std.rst
-	../include/vmod_directors.rst
+	vmod_std.generated.rst
+	vmod_directors.generated.rst
 	vsl.rst
 	vsl-query.rst
 



More information about the varnish-commit mailing list