From: Kent Gibson Date: Fri, 5 Jul 2024 02:17:50 +0000 (+0800) Subject: doc: fix sphinx config for rtd X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=824c1f39347c2ef46919dfc45e8247441b908827;p=qemu-gpiodev%2Flibgpiod.git doc: fix sphinx config for rtd Generating the latest documentation on readthedocs is broken as the index.html generated by Doxygen is now being overwritten by one generated by Sphinx. Make Sphinx generate a differently named root page that does not conflict with the index.html generated by Doxygen. Signed-off-by: Kent Gibson Link: https://lore.kernel.org/r/20240705021750.43197-1-warthog618@gmail.com Signed-off-by: Bartosz Golaszewski --- diff --git a/sphinx/conf.py b/sphinx/conf.py index 51ae3e9..043dc79 100644 --- a/sphinx/conf.py +++ b/sphinx/conf.py @@ -53,6 +53,8 @@ exclude_patterns = [] # -- Options for HTML output ------------------------------------------------- +root_doc = 'contents' + # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # diff --git a/sphinx/contents.rst b/sphinx/contents.rst new file mode 100644 index 0000000..c26d068 --- /dev/null +++ b/sphinx/contents.rst @@ -0,0 +1,24 @@ +.. + SPDX-License-Identifier: LGPL-2.1-or-later + SPDX-FileCopyrightText: 2022 Kent Gibson + +.. + 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` diff --git a/sphinx/index.rst b/sphinx/index.rst deleted file mode 100644 index c26d068..0000000 --- a/sphinx/index.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. - SPDX-License-Identifier: LGPL-2.1-or-later - SPDX-FileCopyrightText: 2022 Kent Gibson - -.. - 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`