From: Nicolas Frattaroli <nicolas.frattaroli@collabora.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: kernel@collabora.com, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org,
Nicolas Frattaroli <nicolas.frattaroli@collabora.com>
Subject: [PATCH 1/2] docs: Document how to use the recommended docs theme
Date: Tue, 20 May 2025 17:57:14 +0200 [thread overview]
Message-ID: <20250520-linked-list-docs-v1-1-db74f7449785@collabora.com> (raw)
In-Reply-To: <20250520-linked-list-docs-v1-0-db74f7449785@collabora.com>
The current documentation on writing documentation documents that the
RTD theme should be used. It goes on to explain how to install it
through pip, but fails to mention how to use it. While the DOCS_THEME
Makeflag is mentioned later on, it's not clear that the pypi package
name of the RTD theme happens to also be the theme's name.
With web search engines approaching a critical mass of uselessness this
decade, let's explicitly mention how to make use of the recommended
theme, in order to save people some effort.
Signed-off-by: Nicolas Frattaroli <nicolas.frattaroli@collabora.com>
---
Documentation/doc-guide/sphinx.rst | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
index 8081ebfe48bc045ff4e86001d3eba884b338bf32..029c350dc12803b53d0c3193acc0cdc5a6777de6 100644
--- a/Documentation/doc-guide/sphinx.rst
+++ b/Documentation/doc-guide/sphinx.rst
@@ -46,7 +46,8 @@ or ``virtualenv``, depending on how your distribution packaged Python 3.
#) It is recommended to use the RTD theme for html output. Depending
on the Sphinx version, it should be installed separately,
- with ``pip install sphinx_rtd_theme``.
+ with ``pip install sphinx_rtd_theme``. You can then pass
+ ``DOCS_THEME=sphinx_rtd_theme`` in your Makeflags to use it.
In summary, if you want to install the latest version of Sphinx, you
should do::
--
2.49.0
next prev parent reply other threads:[~2025-05-20 15:57 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-05-20 15:57 [PATCH 0/2] Add linked list documentation, and also documentation documentation Nicolas Frattaroli
2025-05-20 15:57 ` Nicolas Frattaroli [this message]
2025-05-20 16:14 ` [PATCH 1/2] docs: Document how to use the recommended docs theme Randy Dunlap
2025-05-20 17:48 ` Nicolas Frattaroli
2025-05-20 15:57 ` [PATCH 2/2] docs: document linked lists Nicolas Frattaroli
2025-05-20 16:53 ` Randy Dunlap
2025-06-09 21:20 ` Jonathan Corbet
2025-06-16 7:01 ` Nicolas Frattaroli
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=20250520-linked-list-docs-v1-1-db74f7449785@collabora.com \
--to=nicolas.frattaroli@collabora.com \
--cc=corbet@lwn.net \
--cc=kernel@collabora.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@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
all inboxes | Powered by JetHome®