mirror of
https://gitee.com/openharmony/third_party_nghttp2
synced 2024-11-27 01:50:28 +00:00
Out-of-tree build for sphinx documents
The only drawback is that page source only contains include directive. We disabled page source for now.
This commit is contained in:
parent
2d8c203195
commit
01ca4373a1
@ -399,6 +399,12 @@ AC_CONFIG_FILES([
|
|||||||
python/Makefile
|
python/Makefile
|
||||||
doc/Makefile
|
doc/Makefile
|
||||||
doc/conf.py
|
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
|
AC_OUTPUT
|
||||||
|
|
||||||
|
@ -79,7 +79,8 @@ help:
|
|||||||
|
|
||||||
apiref.rst: $(top_builddir)/lib/includes/nghttp2/nghttp2ver.h \
|
apiref.rst: $(top_builddir)/lib/includes/nghttp2/nghttp2ver.h \
|
||||||
$(top_builddir)/lib/includes/nghttp2/nghttp2.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:
|
clean:
|
||||||
-rm apiref.rst
|
-rm apiref.rst
|
||||||
|
@ -51,7 +51,7 @@ import sys, os
|
|||||||
extensions = []
|
extensions = []
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
templates_path = ['_templates']
|
templates_path = ['@top_srcdir@/_templates']
|
||||||
|
|
||||||
# The suffix of source filenames.
|
# The suffix of source filenames.
|
||||||
source_suffix = '.rst'
|
source_suffix = '.rst'
|
||||||
@ -87,7 +87,7 @@ release = '@PACKAGE_VERSION@'
|
|||||||
|
|
||||||
# List of patterns, relative to source directory, that match files and
|
# List of patterns, relative to source directory, that match files and
|
||||||
# directories to ignore when looking for source files.
|
# 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.
|
# The reST default role (used for this markup: `text`) to use for all documents.
|
||||||
default_role = 'c:func'
|
default_role = 'c:func'
|
||||||
@ -126,7 +126,7 @@ html_theme = 'sphinx_rtd_theme'
|
|||||||
#html_theme_options = {}
|
#html_theme_options = {}
|
||||||
|
|
||||||
# Add any paths that contain custom themes here, relative to this directory.
|
# 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
|
# The name for this set of Sphinx documents. If None, it defaults to
|
||||||
# "<project> v<release> documentation".
|
# "<project> v<release> documentation".
|
||||||
@ -177,7 +177,8 @@ html_sidebars = {
|
|||||||
#html_split_index = False
|
#html_split_index = False
|
||||||
|
|
||||||
# If true, links to the reST sources are added to the pages.
|
# 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.
|
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||||
#html_show_sphinx = True
|
#html_show_sphinx = True
|
||||||
|
1
doc/index.rst.in
Normal file
1
doc/index.rst.in
Normal file
@ -0,0 +1 @@
|
|||||||
|
.. include:: @top_srcdir@/doc/sources/index.rst
|
@ -1,4 +0,0 @@
|
|||||||
nghttp2.h
|
|
||||||
=========
|
|
||||||
|
|
||||||
.. literalinclude:: ../lib/includes/nghttp2/nghttp2.h
|
|
4
doc/nghttp2.h.rst.in
Normal file
4
doc/nghttp2.h.rst.in
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
nghttp2.h
|
||||||
|
=========
|
||||||
|
|
||||||
|
.. literalinclude:: @top_srcdir@/lib/includes/nghttp2/nghttp2.h
|
@ -1,4 +0,0 @@
|
|||||||
nghttp2ver.h
|
|
||||||
============
|
|
||||||
|
|
||||||
.. literalinclude:: ../lib/includes/nghttp2/nghttp2ver.h
|
|
4
doc/nghttp2ver.h.rst.in
Normal file
4
doc/nghttp2ver.h.rst.in
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
nghttp2ver.h
|
||||||
|
============
|
||||||
|
|
||||||
|
.. literalinclude:: @top_builddir@/lib/includes/nghttp2/nghttp2ver.h
|
@ -1 +0,0 @@
|
|||||||
.. include:: ../README.rst
|
|
1
doc/package_README.rst.in
Normal file
1
doc/package_README.rst.in
Normal file
@ -0,0 +1 @@
|
|||||||
|
.. include:: @top_srcdir@/README.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
|
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
|
some data associated for the stream to be closed, you may delete it
|
||||||
here.
|
here.
|
||||||
|
|
||||||
libevent-client.c
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
.. literalinclude:: ../examples/libevent-client.c
|
|
@ -587,9 +587,3 @@ is about to close::
|
|||||||
|
|
||||||
We destroy ``http2_stream_data`` object in this function since the
|
We destroy ``http2_stream_data`` object in this function since the
|
||||||
stream is about to close and we no longer use that object.
|
stream is about to close and we no longer use that object.
|
||||||
|
|
||||||
|
|
||||||
libevent-server.c
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
.. literalinclude:: ../examples/libevent-server.c
|
|
6
doc/tutorial-client.rst.in
Normal file
6
doc/tutorial-client.rst.in
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
.. include:: @top_srcdir@/doc/sources/tutorial-client.rst
|
||||||
|
|
||||||
|
libevent-client.c
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
.. literalinclude:: @top_srcdir@/examples/libevent-client.c
|
6
doc/tutorial-server.rst.in
Normal file
6
doc/tutorial-server.rst.in
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
.. include:: @top_srcdir@/doc/sources/tutorial-server.rst
|
||||||
|
|
||||||
|
libevent-server.c
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
.. literalinclude:: @top_srcdir@/examples/libevent-server.c
|
Loading…
Reference in New Issue
Block a user