mailarchive of the ptxdist mailing list
 help / color / mirror / Atom feed
* [ptxdist] [PATCH] doc: remove search page and genindex from index
@ 2019-03-25 10:01 Bastian Krause
  0 siblings, 0 replies; only message in thread
From: Bastian Krause @ 2019-03-25 10:01 UTC (permalink / raw)
  To: ptxdist; +Cc: Bastian Krause

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

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2019-03-25 10:01 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-03-25 10:01 [ptxdist] [PATCH] doc: remove search page and genindex from index Bastian Krause

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox