Out-of-tree build for sphinx documents

The only drawback is that page source only contains include directive. We disabled page source for now.
doug-wade · Feb 13, 2014 · 01ca437 · 01ca437
1 parent 2d8c203
commit 01ca437
Show file tree

Hide file tree

Showing 15 changed files with 35 additions and 25 deletions.
diff --git a/configure.ac b/configure.ac
@@ -399,6 +399,12 @@ AC_CONFIG_FILES([
   python/Makefile
   doc/Makefile
   doc/conf.py
+  doc/index.rst
+  doc/package_README.rst
+  doc/tutorial-client.rst
+  doc/tutorial-server.rst
+  doc/nghttp2.h.rst
+  doc/nghttp2ver.h.rst
 ])
 AC_OUTPUT
 

diff --git a/doc/Makefile.am b/doc/Makefile.am
@@ -79,7 +79,8 @@ help:
 
 apiref.rst: $(top_builddir)/lib/includes/nghttp2/nghttp2ver.h \
 	$(top_builddir)/lib/includes/nghttp2/nghttp2.h
-	$(PYTHON) $(builddir)/mkapiref.py --header apiref-header.rst $^ > $@
+	$(PYTHON) $(top_srcdir)/doc/mkapiref.py \
+	--header $(top_srcdir)/doc/apiref-header.rst $^ > $@
 
 clean:
 	-rm apiref.rst

diff --git a/doc/conf.py.in b/doc/conf.py.in
@@ -51,7 +51,7 @@ import sys, os
 extensions = []
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ['@top_srcdir@/_templates']
 
 # The suffix of source filenames.
 source_suffix = '.rst'
@@ -87,7 +87,7 @@ release = '@PACKAGE_VERSION@'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['manual', 'README.rst', '*-header.rst']
+exclude_patterns = ['manual', 'README.rst', '*-header.rst', 'sources']
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 default_role = 'c:func'
@@ -126,7 +126,7 @@ html_theme = 'sphinx_rtd_theme'
 #html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = ['_themes']
+html_theme_path = ['@top_srcdir@/doc/_themes']
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
@@ -177,7 +177,8 @@ html_sidebars = {
 #html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+html_show_sourcelink = False
+html_copy_source = False
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 #html_show_sphinx = True

diff --git a/doc/index.rst.in b/doc/index.rst.in
@@ -0,0 +1 @@
+.. include:: @top_srcdir@/doc/sources/index.rst
diff --git a/doc/nghttp2.h.rst b/doc/nghttp2.h.rst
diff --git a/doc/nghttp2.h.rst.in b/doc/nghttp2.h.rst.in
@@ -0,0 +1,4 @@
+nghttp2.h
+=========
+
+.. literalinclude:: @top_srcdir@/lib/includes/nghttp2/nghttp2.h
diff --git a/doc/nghttp2ver.h.rst b/doc/nghttp2ver.h.rst
diff --git a/doc/nghttp2ver.h.rst.in b/doc/nghttp2ver.h.rst.in
@@ -0,0 +1,4 @@
+nghttp2ver.h
+============
+
+.. literalinclude:: @top_builddir@/lib/includes/nghttp2/nghttp2ver.h
diff --git a/doc/package_README.rst b/doc/package_README.rst
diff --git a/doc/package_README.rst.in b/doc/package_README.rst.in
@@ -0,0 +1 @@
+.. include:: @top_srcdir@/README.rst
diff --git a/doc/index.rst → doc/sources/index.rst b/doc/index.rst → doc/sources/index.rst
diff --git a/doc/tutorial-client.rst → doc/sources/tutorial-client.rst b/doc/tutorial-client.rst → doc/sources/tutorial-client.rst
@@ -482,8 +482,3 @@ remote peer), we call `nghttp2_session_terminate_session()` to
 commencing the closure of the HTTP/2.0 session gracefully. If you have
 some data associated for the stream to be closed, you may delete it
 here.
-
-libevent-client.c
------------------
-
-.. literalinclude:: ../examples/libevent-client.c
diff --git a/doc/tutorial-server.rst → doc/sources/tutorial-server.rst b/doc/tutorial-server.rst → doc/sources/tutorial-server.rst
@@ -587,9 +587,3 @@ is about to close::
 
 We destroy ``http2_stream_data`` object in this function since the
 stream is about to close and we no longer use that object.
-
-
-libevent-server.c
------------------
-
-.. literalinclude:: ../examples/libevent-server.c
diff --git a/doc/tutorial-client.rst.in b/doc/tutorial-client.rst.in
@@ -0,0 +1,6 @@
+.. include:: @top_srcdir@/doc/sources/tutorial-client.rst
+
+libevent-client.c
+-----------------
+
+.. literalinclude:: @top_srcdir@/examples/libevent-client.c
diff --git a/doc/tutorial-server.rst.in b/doc/tutorial-server.rst.in
@@ -0,0 +1,6 @@
+.. include:: @top_srcdir@/doc/sources/tutorial-server.rst
+
+libevent-server.c
+-----------------
+
+.. literalinclude:: @top_srcdir@/examples/libevent-server.c
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		.. include:: @top_srcdir@/doc/sources/index.rst