doc: Include header files in documentation

2013-09-04 22:57:02 +09:00 · 2013-09-04 22:57:02 +09:00 · 50dd5074a5
parent 2c264f60a6
commit 50dd5074a5
4 changed files with 13 additions and 0 deletions
--- a/doc/apiref-header.rst
+++ b/doc/apiref-header.rst
@ -8,6 +8,9 @@ To use the public APIs, include ``nghttp2/nghttp2.h``::

    #include <nghttp2/nghttp2.h>

+The header files are also available online: :doc:`nghttp2.h` and
+:doc:`nghttp2ver.h`.
+
 Remarks
 -------

--- a/doc/index.rst
+++ b/doc/index.rst
@ -16,6 +16,8 @@ Contents:

   package_README
   apiref
+   nghttp2.h
+   nghttp2ver.h

 Resources
 ---------
--- a/doc/nghttp2.h.rst
+++ b/doc/nghttp2.h.rst
@ -0,0 +1,4 @@
+nghttp2.h
+=========
+
+.. literalinclude:: ../lib/includes/nghttp2/nghttp2.h
--- a/doc/nghttp2ver.h.rst
+++ b/doc/nghttp2ver.h.rst
@ -0,0 +1,4 @@
+nghttp2ver.h
+============
+
+.. literalinclude:: ../lib/includes/nghttp2/nghttp2ver.h