doc: add configuration to generate doxygen documentation on readthedocs.
PATCH v2 1/1 doc: add configuration to generate doxygen documentation on readthedocs.
Having the libgpiod documentation available online would be helpful, so add the configuration required to generate the existing docygen C/C++ documentation on readthedocs.
Signed-off-by Kent Gibson <[email protected]>
---
Changes v1 -> v2:
- update copyright headers to be reuse compliant.
- update to contemporary rtd build environment
.readthedocs.yaml | 28 +++++++++++++++++++ sphinx/conf.py | 69 +++++++++++++++++++++++++++++++++++++++++++++++ sphinx/index.rst | 24 +++++++++++++++++ 3 files changed, 121 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 sphinx/conf.py create mode 100644 sphinx/index.rst
.readthedocs.yaml new file +28 -0
@@ -0,0 +1,28 @@ +# SPDX-License-Identifier: LGPL-2.1-or-later +# SPDX-FileCopyrightText: 2022 Kent Gibson <[email protected]> + +# +# This file is part of libgpiod. +# +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.11" + # doxygen is available by default, but just in case. + # others are definitely missing. + apt_packages: + - autoconf + - autoconf-archive + - libtool + - m4 + - doxygen + - graphviz + +sphinx: + configuration: sphinx/conf.py +
sphinx/conf.py new file +69 -0
69 lines not on this page · raw message
sphinx/index.rst new file +24 -0
@@ -0,0 +1,24 @@ +.. + SPDX-License-Identifier: LGPL-2.1-or-later + SPDX-FileCopyrightText: 2022 Kent Gibson <[email protected]> + +.. + This file is part of libgpiod. + + libgpiod documentation master file. + +Welcome to libgpiod's documentation! +==================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search`
Signature · 1 line
2.40.1