mirror of
https://git.kernel.org/pub/scm/libs/libgpiod/libgpiod.git
synced 2026-10-24 00:48:53 +03:00
7e11886fff
Current sphinx/ contents are mostly WiP. Let's beat them into shape for publishing on ReadTheDocs. Integrate the API documentation generated with doxygen for the core C API and C++ bindings into sphinx using breathe. Update configure.ac to check for sphinx-build in addition to doxygen and make the main Makefile trigger a sphinx build on `make doc` (although the docs can also be generated without starting the build system by running: `sphinx-build ./docs/ docs/sphinx-output`). Move the introduction text from the main header into the relevant .rst file. Remove obsolete Doxyfile.in and create a static Doxygen under doc/ where all the documentation now lives. Update .gitignore where needed. Reviewed-by: Vincent Fazio <vfazio@xes-inc.com> Link: https://lore.kernel.org/r/20250211-improve-docs-v4-12-dc56702c2ca8@linaro.org Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
63 lines
963 B
Makefile
63 lines
963 B
Makefile
# SPDX-License-Identifier: GPL-2.0-or-later
|
|
# SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com>
|
|
# SPDX-FileCopyrightText: 2022 Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
|
|
|
|
ACLOCAL_AMFLAGS = -I m4
|
|
AUTOMAKE_OPTIONS = foreign
|
|
SUBDIRS = include lib contrib
|
|
|
|
EXTRA_DIST = \
|
|
LICENSES/GPL-2.0-or-later.txt \
|
|
LICENSES/Apache-2.0.txt \
|
|
LICENSES/LGPL-2.1-or-later.txt \
|
|
LICENSES/CC-BY-SA-4.0.txt \
|
|
LICENSES/CC0-1.0.txt \
|
|
LICENSES/GPL-2.0-only.txt \
|
|
LICENSES/Linux-syscall-note.txt \
|
|
LICENSES/BSD-3-Clause.txt
|
|
|
|
if WITH_EXAMPLES
|
|
|
|
SUBDIRS += examples
|
|
|
|
endif
|
|
|
|
if WITH_TOOLS
|
|
|
|
SUBDIRS += tools
|
|
|
|
endif
|
|
|
|
if WITH_TESTS
|
|
|
|
SUBDIRS += tests
|
|
|
|
endif
|
|
|
|
# Build bindings after core tests. When building tests for bindings, we need
|
|
# libgpiosim to be already present.
|
|
SUBDIRS += bindings
|
|
|
|
if WITH_DBUS
|
|
|
|
SUBDIRS += dbus
|
|
|
|
endif
|
|
|
|
if WITH_MANPAGES
|
|
|
|
SUBDIRS += man
|
|
|
|
endif
|
|
|
|
if WITH_DOCS
|
|
|
|
SUBDIRS += docs
|
|
|
|
docs:
|
|
$(MAKE) -C docs docs
|
|
|
|
.PHONY: docs
|
|
|
|
endif
|