fdo-mirrors/libei
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libinput/libei.git synced 2026-05-04 23:38:01 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Generate the protocol documentation in gitlab pages

Browse source
This commit is contained in:
Peter Hutterer 2023-03-03 14:57:20 +10:00
parent 3d3b20f172
commit 717900f6fe
4 changed files with 27 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
.gitlab-ci.yml
View file

@ -32,14 +32,14 @@ variables:
# See the documentation here: #
# https://wayland.freedesktop.org/libinput/doc/latest/building_libinput.html #
###############################################################################
FEDORA_PACKAGES: 'git diffutils gcc gcc-c++ pkgconf-pkg-config meson systemd-devel libxkbcommon-devel libxml2 doxygen python3-attrs python3-pytest python3-dbusmock python3-jinja2 python3-pip '
FEDORA_PACKAGES: 'git diffutils gcc gcc-c++ pkgconf-pkg-config meson systemd-devel libxkbcommon-devel libxml2 doxygen python3-attrs python3-pytest python3-dbusmock python3-jinja2 python3-pip hugo '
############################ end of package lists #############################
# these tags should be updated each time the list of packages is updated
# changing these will force rebuilding the associated image
# Note: these tags have no meaning and are not tied to a particular
# libinput version
FEDORA_TAG: '2023-02-23.1'
FEDORA_TAG: '2023-03-03.0'
FDO_UPSTREAM_REPO: libinput/libei
@ -278,8 +278,14 @@ pages:
FDO_DISTRIBUTION_VERSION: '37'
FDO_DISTRIBUTION_TAG: $FEDORA_TAG
MESON_ARGS: "-Ddocumentation=true"
after_script:
- mv "$MESON_BUILDDIR"/doc/html/ public
script:
- .gitlab-ci/meson-build.sh
- ./doc/hugo/generate-protocol-docs.sh -v --scanner "$PWD/proto/ei-scanner" --protocol "$PWD/proto/protocol.xml" --index-page "$PWD/README.md" --template-dir "$PWD/doc/hugo" --output-dir "$PWD/_hugo"
- cd _hugo/ei && hugo && cd ../..
- mv _hugo/ei/public/ public/
- mkdir -p public/api
- mv "$MESON_BUILDDIR"/doc/html/ public/api
only:
refs:
- main

10
.gitlab-ci/ci.template
View file

@ -305,8 +305,14 @@ pages:
FDO_DISTRIBUTION_VERSION: '{{pages.version}}'
FDO_DISTRIBUTION_TAG: ${{pages.distro.upper()}}_TAG
MESON_ARGS: "-Ddocumentation=true"
after_script:
- mv "$MESON_BUILDDIR"/doc/html/ public
script:
- .gitlab-ci/meson-build.sh
- ./doc/hugo/generate-protocol-docs.sh -v --scanner "$PWD/proto/ei-scanner" --protocol "$PWD/proto/protocol.xml" --index-page "$PWD/README.md" --template-dir "$PWD/doc/hugo" --output-dir "$PWD/_hugo"
- cd _hugo/ei && hugo && cd ../..
- mv _hugo/ei/public/ public/
- mkdir -p public/api
- mv "$MESON_BUILDDIR"/doc/html/ public/api
only:
refs:
- main

3
.gitlab-ci/config.yml
View file

@ -3,7 +3,7 @@
#
# We're happy to rebuild all containers when one changes.
.default_tag: &default_tag '2023-02-23.1'
.default_tag: &default_tag '2023-03-03.0'
distributions:
- name: fedora
@ -27,6 +27,7 @@ distributions:
- python3-dbusmock
- python3-jinja2
- python3-pip
- hugo # for documentation only
pages:
distro: fedora

8
README.md
View file

@ -18,9 +18,15 @@ For the purpose of this document, **libei** refers to the project,
Documentation
-------------
The API documentation is available
The protocol documentation is available
[here](https://libinput.pages.freedesktop.org/libei/)
The C library API documentation is available here:
- [libei](https://libinput.pages.freedesktop.org/libei/api/group__libei.html)
- [libeis](https://libinput.pages.freedesktop.org/libei/api/group__libeis.html)
- [liboffis](https://libinput.pages.freedesktop.org/libei/api/group__liboeffis.html)
Overview
--------