From: Bastian Krause <bst@pengutronix.de>
To: ptxdist@pengutronix.de
Cc: Bastian Krause <bst@pengutronix.de>
Subject: [ptxdist] [PATCH] doc: remove search page and genindex from index
Date: Mon, 25 Mar 2019 11:01:55 +0100 [thread overview]
Message-ID: <20190325100155.26956-1-bst@pengutronix.de> (raw)
The ptxdist documentation does not use index directives (e.g.
".. index:: Foo"), so the automatically generated index page is always
empty. So remove it. If this directive is used some day we can add it
again.
The ptxdist theme already includes search functionality, so remove the
search directive as well.
These special names are documented here:
https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#special-names
This is also a workaround for a sphinx bug accidentally showing these
directives in pdf output:
https://github.com/sphinx-doc/sphinx/issues/2827
Signed-off-by: Bastian Krause <bst@pengutronix.de>
---
doc/index.rst | 4 ----
1 file changed, 4 deletions(-)
diff --git a/doc/index.rst b/doc/index.rst
index 36edb4752..6a01d6dd7 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -20,7 +20,3 @@ Welcome to the PTXdist Universe
contributing
faq
getting_help
-
-* :ref:`search`
-* :ref:`genindex`
-
--
2.20.1
_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de
reply other threads:[~2019-03-25 10:01 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=20190325100155.26956-1-bst@pengutronix.de \
--to=bst@pengutronix.de \
--cc=ptxdist@pengutronix.de \
/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