public inbox for linux-gpio@vger.kernel.org
 help / color / mirror / Atom feed
From: Kent Gibson <warthog618@gmail.com>
To: linux-gpio@vger.kernel.org, brgl@bgdev.pl
Cc: Kent Gibson <warthog618@gmail.com>
Subject: [libgpiod][PATCH] doc: fix sphinx config for rtd
Date: Fri,  5 Jul 2024 10:17:50 +0800	[thread overview]
Message-ID: <20240705021750.43197-1-warthog618@gmail.com> (raw)

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 <warthog618@gmail.com>
---
 sphinx/conf.py                     | 2 ++
 sphinx/{index.rst => contents.rst} | 0
 2 files changed, 2 insertions(+)
 rename sphinx/{index.rst => contents.rst} (100%)

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/index.rst b/sphinx/contents.rst
similarity index 100%
rename from sphinx/index.rst
rename to sphinx/contents.rst
-- 
2.39.2


             reply	other threads:[~2024-07-05  2:17 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-07-05  2:17 Kent Gibson [this message]
2024-07-05  7:41 ` [libgpiod][PATCH] doc: fix sphinx config for rtd Bartosz Golaszewski
2024-07-06  2:54   ` Kent Gibson
2024-07-08 11:48     ` Bartosz Golaszewski
2024-07-08 12:43       ` Kent Gibson
2024-07-08 13:50         ` Bartosz Golaszewski
2024-07-08 15:15           ` Kent Gibson
2024-07-08 15:19             ` Bartosz Golaszewski
2024-07-08 15:29               ` Kent Gibson
2024-07-09  9:34                 ` Kent Gibson
2024-07-09 15:48                   ` Bartosz Golaszewski
2024-07-10  1:48                     ` Kent Gibson
2024-07-10  7:55                       ` Bartosz Golaszewski
2024-07-09  8:22       ` Viresh Kumar

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240705021750.43197-1-warthog618@gmail.com \
    --to=warthog618@gmail.com \
    --cc=brgl@bgdev.pl \
    --cc=linux-gpio@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox