summaryrefslogtreecommitdiffstatshomepage
path: root/docs/sphinx_selective_exclude/search_auto_exclude.py
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2018-09-27 17:36:04 +1000
committerDamien George <damien.p.george@gmail.com>2018-10-01 13:54:32 +1000
commitd1adfee2510d1e9fda8141e00ca0d96d88da9605 (patch)
treef5ed4bc46688432bd3daeb869613a1ab10ad38fb /docs/sphinx_selective_exclude/search_auto_exclude.py
parentb3e013f60ec0feb5b64bcadb45b154d093731c97 (diff)
downloadmicropython-d1adfee2510d1e9fda8141e00ca0d96d88da9605.tar.gz
micropython-d1adfee2510d1e9fda8141e00ca0d96d88da9605.zip
docs: Remove sphinx_selective_exclude, it's no longer used.
Diffstat (limited to 'docs/sphinx_selective_exclude/search_auto_exclude.py')
-rw-r--r--docs/sphinx_selective_exclude/search_auto_exclude.py34
1 files changed, 0 insertions, 34 deletions
diff --git a/docs/sphinx_selective_exclude/search_auto_exclude.py b/docs/sphinx_selective_exclude/search_auto_exclude.py
deleted file mode 100644
index b8b326dd2c..0000000000
--- a/docs/sphinx_selective_exclude/search_auto_exclude.py
+++ /dev/null
@@ -1,34 +0,0 @@
-#
-# This is a Sphinx documentation tool extension which allows to
-# automatically exclude from full-text search index document
-# which are not referenced via toctree::. It's intended to be
-# used with toctrees conditional on only:: directive, with the
-# idea being that if you didn't include it in the ToC, you don't
-# want the docs being findable by search either (for example,
-# because these docs contain information not pertinent to a
-# particular product configuration).
-#
-# This extension depends on "eager_only" extension and won't work
-# without it.
-#
-# Copyright (c) 2016 Paul Sokolovsky
-# Licensed under the terms of BSD license, see LICENSE file.
-#
-import sphinx
-
-
-org_StandaloneHTMLBuilder_index_page = None
-
-
-def StandaloneHTMLBuilder_index_page(self, pagename, doctree, title):
- if pagename not in self.env.files_to_rebuild:
- if pagename != self.env.config.master_doc and 'orphan' not in self.env.metadata[pagename]:
- print("Excluding %s from full-text index because it's not referenced in ToC" % pagename)
- return
- return org_StandaloneHTMLBuilder_index_page(self, pagename, doctree, title)
-
-
-def setup(app):
- global org_StandaloneHTMLBuilder_index_page
- org_StandaloneHTMLBuilder_index_page = sphinx.builders.html.StandaloneHTMLBuilder.index_page
- sphinx.builders.html.StandaloneHTMLBuilder.index_page = StandaloneHTMLBuilder_index_page