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>
13 lines
359 B
Plaintext
13 lines
359 B
Plaintext
# SPDX-License-Identifier: CC-BY-SA-4.0
|
|
# SPDX-FileCopyrightText: 2022 Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
|
|
|
|
PROJECT_NAME = libgpiod
|
|
OUTPUT_DIRECTORY = doxygen-output
|
|
INPUT = ../include/gpiod.h \
|
|
../bindings/cxx/gpiod.hpp \
|
|
../bindings/cxx/gpiodcxx/
|
|
GENERATE_XML = YES
|
|
WARN_IF_UNDOCUMENTED = YES
|
|
QUIET = YES
|
|
EXTRACT_ALL = YES
|