doc/Makefile.am

   1 # nghttp2 - HTTP/2 C Library
   2
   3 # Copyright (c) 2012 Tatsuhiro Tsujikawa
   4
   5 # Permission is hereby granted, free of charge, to any person obtaining
   6 # a copy of this software and associated documentation files (the
   7 # "Software"), to deal in the Software without restriction, including
   8 # without limitation the rights to use, copy, modify, merge, publish,
   9 # distribute, sublicense, and/or sell copies of the Software, and to
  10 # permit persons to whom the Software is furnished to do so, subject to
  11 # the following conditions:
  12
  13 # The above copyright notice and this permission notice shall be
  14 # included in all copies or substantial portions of the Software.
  15
  16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23
  24 man_MANS = nghttp.1 nghttpd.1 nghttpx.1 h2load.1
  25
  26 APIDOCS= \
  27         macros.rst \
  28         enums.rst \
  29         types.rst \
  30         nghttp2_check_authority.rst \
  31         nghttp2_check_header_name.rst \
  32         nghttp2_check_header_value.rst \
  33         nghttp2_hd_deflate_bound.rst \
  34         nghttp2_hd_deflate_change_table_size.rst \
  35         nghttp2_hd_deflate_del.rst \
  36         nghttp2_hd_deflate_get_dynamic_table_size.rst \
  37         nghttp2_hd_deflate_get_max_dynamic_table_size.rst \
  38         nghttp2_hd_deflate_get_num_table_entries.rst \
  39         nghttp2_hd_deflate_get_table_entry.rst \
  40         nghttp2_hd_deflate_hd.rst \
  41         nghttp2_hd_deflate_hd_vec.rst \
  42         nghttp2_hd_deflate_new.rst \
  43         nghttp2_hd_deflate_new2.rst \
  44         nghttp2_hd_inflate_change_table_size.rst \
  45         nghttp2_hd_inflate_del.rst \
  46         nghttp2_hd_inflate_end_headers.rst \
  47         nghttp2_hd_inflate_get_dynamic_table_size.rst \
  48         nghttp2_hd_inflate_get_max_dynamic_table_size.rst \
  49         nghttp2_hd_inflate_get_num_table_entries.rst \
  50         nghttp2_hd_inflate_get_table_entry.rst \
  51         nghttp2_hd_inflate_hd.rst \
  52         nghttp2_hd_inflate_hd2.rst \
  53         nghttp2_hd_inflate_new.rst \
  54         nghttp2_hd_inflate_new2.rst \
  55         nghttp2_http2_strerror.rst \
  56         nghttp2_is_fatal.rst \
  57         nghttp2_nv_compare_name.rst \
  58         nghttp2_option_del.rst \
  59         nghttp2_option_new.rst \
  60         nghttp2_option_set_builtin_recv_extension_type.rst \
  61         nghttp2_option_set_max_deflate_dynamic_table_size.rst \
  62         nghttp2_option_set_max_reserved_remote_streams.rst \
  63         nghttp2_option_set_max_send_header_block_length.rst \
  64         nghttp2_option_set_no_auto_ping_ack.rst \
  65         nghttp2_option_set_no_auto_window_update.rst \
  66         nghttp2_option_set_no_closed_streams.rst \
  67         nghttp2_option_set_no_http_messaging.rst \
  68         nghttp2_option_set_no_recv_client_magic.rst \
  69         nghttp2_option_set_peer_max_concurrent_streams.rst \
  70         nghttp2_option_set_user_recv_extension_type.rst \
  71         nghttp2_option_set_max_outbound_ack.rst \
  72         nghttp2_option_set_max_settings.rst \
  73         nghttp2_pack_settings_payload.rst \
  74         nghttp2_priority_spec_check_default.rst \
  75         nghttp2_priority_spec_default_init.rst \
  76         nghttp2_priority_spec_init.rst \
  77         nghttp2_rcbuf_decref.rst \
  78         nghttp2_rcbuf_get_buf.rst \
  79         nghttp2_rcbuf_incref.rst \
  80         nghttp2_rcbuf_is_static.rst \
  81         nghttp2_select_next_protocol.rst \
  82         nghttp2_session_callbacks_del.rst \
  83         nghttp2_session_callbacks_new.rst \
  84         nghttp2_session_callbacks_set_before_frame_send_callback.rst \
  85         nghttp2_session_callbacks_set_data_source_read_length_callback.rst \
  86         nghttp2_session_callbacks_set_error_callback.rst \
  87         nghttp2_session_callbacks_set_error_callback2.rst \
  88         nghttp2_session_callbacks_set_on_begin_frame_callback.rst \
  89         nghttp2_session_callbacks_set_on_begin_headers_callback.rst \
  90         nghttp2_session_callbacks_set_on_data_chunk_recv_callback.rst \
  91         nghttp2_session_callbacks_set_on_extension_chunk_recv_callback.rst \
  92         nghttp2_session_callbacks_set_on_frame_not_send_callback.rst \
  93         nghttp2_session_callbacks_set_on_frame_recv_callback.rst \
  94         nghttp2_session_callbacks_set_on_frame_send_callback.rst \
  95         nghttp2_session_callbacks_set_on_header_callback.rst \
  96         nghttp2_session_callbacks_set_on_header_callback2.rst \
  97         nghttp2_session_callbacks_set_on_invalid_frame_recv_callback.rst \
  98         nghttp2_session_callbacks_set_on_invalid_header_callback.rst \
  99         nghttp2_session_callbacks_set_on_invalid_header_callback2.rst \
 100         nghttp2_session_callbacks_set_on_stream_close_callback.rst \
 101         nghttp2_session_callbacks_set_pack_extension_callback.rst \
 102         nghttp2_session_callbacks_set_recv_callback.rst \
 103         nghttp2_session_callbacks_set_select_padding_callback.rst \
 104         nghttp2_session_callbacks_set_send_callback.rst \
 105         nghttp2_session_callbacks_set_send_data_callback.rst \
 106         nghttp2_session_callbacks_set_unpack_extension_callback.rst \
 107         nghttp2_session_change_stream_priority.rst \
 108         nghttp2_session_check_request_allowed.rst \
 109         nghttp2_session_check_server_session.rst \
 110         nghttp2_session_client_new.rst \
 111         nghttp2_session_client_new2.rst \
 112         nghttp2_session_client_new3.rst \
 113         nghttp2_session_consume.rst \
 114         nghttp2_session_consume_connection.rst \
 115         nghttp2_session_consume_stream.rst \
 116         nghttp2_session_create_idle_stream.rst \
 117         nghttp2_session_del.rst \
 118         nghttp2_session_find_stream.rst \
 119         nghttp2_session_get_effective_local_window_size.rst \
 120         nghttp2_session_get_effective_recv_data_length.rst \
 121         nghttp2_session_get_hd_deflate_dynamic_table_size.rst \
 122         nghttp2_session_get_hd_inflate_dynamic_table_size.rst \
 123         nghttp2_session_get_last_proc_stream_id.rst \
 124         nghttp2_session_get_local_settings.rst \
 125         nghttp2_session_get_local_window_size.rst \
 126         nghttp2_session_get_next_stream_id.rst \
 127         nghttp2_session_get_outbound_queue_size.rst \
 128         nghttp2_session_get_remote_settings.rst \
 129         nghttp2_session_get_remote_window_size.rst \
 130         nghttp2_session_get_root_stream.rst \
 131         nghttp2_session_get_stream_effective_local_window_size.rst \
 132         nghttp2_session_get_stream_effective_recv_data_length.rst \
 133         nghttp2_session_get_stream_local_close.rst \
 134         nghttp2_session_get_stream_local_window_size.rst \
 135         nghttp2_session_get_stream_remote_close.rst \
 136         nghttp2_session_get_stream_remote_window_size.rst \
 137         nghttp2_session_get_stream_user_data.rst \
 138         nghttp2_session_mem_recv.rst \
 139         nghttp2_session_mem_send.rst \
 140         nghttp2_session_recv.rst \
 141         nghttp2_session_resume_data.rst \
 142         nghttp2_session_send.rst \
 143         nghttp2_session_server_new.rst \
 144         nghttp2_session_server_new2.rst \
 145         nghttp2_session_server_new3.rst \
 146         nghttp2_session_set_local_window_size.rst \
 147         nghttp2_session_set_next_stream_id.rst \
 148         nghttp2_session_set_stream_user_data.rst \
 149         nghttp2_session_set_user_data.rst \
 150         nghttp2_session_terminate_session.rst \
 151         nghttp2_session_terminate_session2.rst \
 152         nghttp2_session_upgrade.rst \
 153         nghttp2_session_upgrade2.rst \
 154         nghttp2_session_want_read.rst \
 155         nghttp2_session_want_write.rst \
 156         nghttp2_set_debug_vprintf_callback.rst \
 157         nghttp2_stream_get_first_child.rst \
 158         nghttp2_stream_get_next_sibling.rst \
 159         nghttp2_stream_get_parent.rst \
 160         nghttp2_stream_get_previous_sibling.rst \
 161         nghttp2_stream_get_state.rst \
 162         nghttp2_stream_get_sum_dependency_weight.rst \
 163         nghttp2_stream_get_weight.rst \
 164         nghttp2_strerror.rst \
 165         nghttp2_submit_altsvc.rst \
 166         nghttp2_submit_data.rst \
 167         nghttp2_submit_extension.rst \
 168         nghttp2_submit_goaway.rst \
 169         nghttp2_submit_headers.rst \
 170         nghttp2_submit_origin.rst \
 171         nghttp2_submit_ping.rst \
 172         nghttp2_submit_priority.rst \
 173         nghttp2_submit_push_promise.rst \
 174         nghttp2_submit_request.rst \
 175         nghttp2_submit_response.rst \
 176         nghttp2_submit_rst_stream.rst \
 177         nghttp2_submit_settings.rst \
 178         nghttp2_submit_shutdown_notice.rst \
 179         nghttp2_submit_trailer.rst \
 180         nghttp2_submit_window_update.rst \
 181         nghttp2_version.rst
 182
 183 RST_FILES = \
 184         README.rst \
 185         programmers-guide.rst \
 186         nghttp.1.rst \
 187         nghttpd.1.rst \
 188         nghttpx.1.rst \
 189         h2load.1.rst
 190
 191 EXTRA_DIST = \
 192         CMakeLists.txt \
 193         mkapiref.py \
 194         $(RST_FILES) \
 195         $(APIDOCS) \
 196         sources/index.rst \
 197         sources/tutorial-client.rst \
 198         sources/tutorial-server.rst \
 199         sources/tutorial-hpack.rst \
 200         sources/nghttpx-howto.rst \
 201         sources/h2load-howto.rst \
 202         sources/libnghttp2_asio.rst \
 203         sources/python-apiref.rst \
 204         sources/building-android-binary.rst \
 205         sources/contribute.rst \
 206         _exts/sphinxcontrib/LICENSE.rubydomain \
 207         _exts/sphinxcontrib/__init__.py \
 208         _exts/sphinxcontrib/rubydomain.py \
 209         _themes/sphinx_rtd_theme/__init__.py \
 210         _themes/sphinx_rtd_theme/breadcrumbs.html \
 211         _themes/sphinx_rtd_theme/footer.html \
 212         _themes/sphinx_rtd_theme/layout.html \
 213         _themes/sphinx_rtd_theme/layout_old.html \
 214         _themes/sphinx_rtd_theme/search.html \
 215         _themes/sphinx_rtd_theme/searchbox.html \
 216         _themes/sphinx_rtd_theme/static/css/badge_only.css \
 217         _themes/sphinx_rtd_theme/static/css/theme.css \
 218         _themes/sphinx_rtd_theme/static/fonts/FontAwesome.otf \
 219         _themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.eot \
 220         _themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.svg \
 221         _themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.ttf \
 222         _themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.woff \
 223         _themes/sphinx_rtd_theme/static/js/theme.js \
 224         _themes/sphinx_rtd_theme/theme.conf \
 225         _themes/sphinx_rtd_theme/versions.html \
 226         $(man_MANS) \
 227         bash_completion/nghttp \
 228         bash_completion/nghttpd \
 229         bash_completion/nghttpx \
 230         bash_completion/h2load
 231
 232 # Makefile for Sphinx documentation
 233 #
 234
 235 # You can set these variables from the command line.
 236 SPHINXOPTS    =
 237 SPHINXBUILD   = sphinx-build
 238 PAPER         =
 239 BUILDDIR      = manual
 240
 241 # Internal variables.
 242 PAPEROPT_a4     = -D latex_paper_size=a4
 243 PAPEROPT_letter = -D latex_paper_size=letter
 244 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 245
 246 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
 247
 248 help:
 249         @echo "Please use \`make <target>' where <target> is one of"
 250         @echo "  html       to make standalone HTML files"
 251         @echo "  dirhtml    to make HTML files named index.html in directories"
 252         @echo "  singlehtml to make a single large HTML file"
 253         @echo "  pickle     to make pickle files"
 254         @echo "  json       to make JSON files"
 255         @echo "  htmlhelp   to make HTML files and a HTML help project"
 256         @echo "  qthelp     to make HTML files and a qthelp project"
 257         @echo "  devhelp    to make HTML files and a Devhelp project"
 258         @echo "  epub       to make an epub"
 259         @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
 260         @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
 261         @echo "  text       to make text files"
 262         @echo "  man        to make manual pages"
 263         @echo "  changes    to make an overview of all changed/added/deprecated items"
 264         @echo "  linkcheck  to check all external links for integrity"
 265         @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 266
 267 apiref.rst: \
 268         $(top_builddir)/lib/includes/nghttp2/nghttp2ver.h \
 269         $(top_srcdir)/lib/includes/nghttp2/nghttp2.h
 270         for i in $(RST_FILES); do [ -e $(builddir)/$$i ] || cp $(srcdir)/$$i $(builddir); done
 271         $(PYTHON) $(top_srcdir)/doc/mkapiref.py \
 272         apiref.rst macros.rst enums.rst types.rst . $^
 273
 274 $(APIDOCS): apiref.rst
 275
 276 clean-local:
 277         if [ $(srcdir) != $(builddir) ]; then for i in $(RST_FILES); do rm -f $(builddir)/$$i; done fi
 278         -rm -f apiref.rst
 279         -rm -f $(APIDOCS)
 280         -rm -rf $(BUILDDIR)/*
 281
 282 html-local: apiref.rst
 283         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 284         @echo
 285         @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 286
 287 dirhtml:
 288         $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 289         @echo
 290         @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 291
 292 singlehtml:
 293         $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
 294         @echo
 295         @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
 296
 297 pickle:
 298         $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
 299         @echo
 300         @echo "Build finished; now you can process the pickle files."
 301
 302 json:
 303         $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
 304         @echo
 305         @echo "Build finished; now you can process the JSON files."
 306
 307 htmlhelp:
 308         $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
 309         @echo
 310         @echo "Build finished; now you can run HTML Help Workshop with the" \
 311               ".hhp project file in $(BUILDDIR)/htmlhelp."
 312
 313 qthelp:
 314         $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
 315         @echo
 316         @echo "Build finished; now you can run "qcollectiongenerator" with the" \
 317               ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
 318         @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/nghttp2.qhcp"
 319         @echo "To view the help file:"
 320         @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/nghttp2.qhc"
 321
 322 devhelp:
 323         $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 324         @echo
 325         @echo "Build finished."
 326         @echo "To view the help file:"
 327         @echo "# mkdir -p $$HOME/.local/share/devhelp/nghttp2"
 328         @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/nghttp2"
 329         @echo "# devhelp"
 330
 331 epub:
 332         $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
 333         @echo
 334         @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
 335
 336 latex:
 337         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 338         @echo
 339         @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
 340         @echo "Run \`make' in that directory to run these through (pdf)latex" \
 341               "(use \`make latexpdf' here to do that automatically)."
 342
 343 latexpdf:
 344         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 345         @echo "Running LaTeX files through pdflatex..."
 346         $(MAKE) -C $(BUILDDIR)/latex all-pdf
 347         @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 348
 349 text:
 350         $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
 351         @echo
 352         @echo "Build finished. The text files are in $(BUILDDIR)/text."
 353
 354 man: apiref.rst
 355         $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
 356         @echo
 357         @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
 358
 359 changes:
 360         $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
 361         @echo
 362         @echo "The overview file is in $(BUILDDIR)/changes."
 363
 364 linkcheck:
 365         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
 366         @echo
 367         @echo "Link check complete; look for any errors in the above output " \
 368               "or in $(BUILDDIR)/linkcheck/output.txt."
 369
 370 doctest:
 371         $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 372         @echo "Testing of doctests in the sources finished, look at the " \
 373               "results in $(BUILDDIR)/doctest/output.txt."