fdo-mirrors/libinput
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libinput/libinput.git synced 2025-12-24 18:10:06 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc/user: add a link to the API documentation in the TOC

Browse source 
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This commit is contained in:
Peter Hutterer 2019-10-17 13:53:07 +10:00
parent 61f81ec93e
commit df0be64baa
2 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/user/index.rst
View file

@ -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.

6
doc/user/meson.build
View file

@ -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'