From: Peter Hutterer Date: Thu, 17 Oct 2019 03:53:07 +0000 (+1000) Subject: doc/user: add a link to the API documentation in the TOC X-Git-Tag: 1.14.901~72 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=df0be64baa2e51df22420bccb476564c8655a19f;p=platform%2Fupstream%2Flibinput.git doc/user: add a link to the API documentation in the TOC Signed-off-by: Peter Hutterer --- diff --git a/doc/user/index.rst b/doc/user/index.rst index aaa84d79..7aea1e6b 100644 --- a/doc/user/index.rst +++ b/doc/user/index.rst @@ -11,6 +11,7 @@ reporting-bugs troubleshooting development + API documentation <@HTTP_DOC_LINK@> ++++++++++++++++++++++++++++++ @@ -41,7 +42,7 @@ API documentation ----------------- The API documentation is available here: - http://wayland.freedesktop.org/libinput/doc/latest/api/ + https://wayland.freedesktop.org/libinput/doc/latest/api/ .. note:: This documentation is generally only needed by authors of Wayland compositors or other developers dealing with input events directly. diff --git a/doc/user/meson.build b/doc/user/meson.build index f9904f10..c5dc32a4 100644 --- a/doc/user/meson.build +++ b/doc/user/meson.build @@ -8,6 +8,7 @@ sphinx_config = configuration_data() sphinx_config.set('PROJECT_NAME', meson.project_name()) sphinx_config.set('PROJECT_VERSION', meson.project_version()) sphinx_config.set('BUILDDIR', meson.current_build_dir()) +sphinx_config.set('HTTP_DOC_LINK', doc_url) git_version_page = vcs_tag(command : ['git', 'log', '-1', '--format=%H'], fallback : 'unknown', @@ -137,7 +138,6 @@ src_rst = files( 'device-quirks.rst', 'faqs.rst', 'gestures.rst', - 'index.rst', 'middle-button-emulation.rst', 'normalization-of-relative-motion.rst', 'palm-detection.rst', @@ -183,6 +183,10 @@ foreach f : src_rst src_sphinx += [ sf ] endforeach +configure_file(input: 'index.rst', + output: 'index.rst', + configuration: sphinx_config) + # do not use -j, it breaks on Ubuntu sphinx_output_dir = 'Documentation'