FilesExpand file tree

esp-extra-scripts

/

search_auto_exclude.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

34 lines (28 loc) · 1.36 KB

esp-extra-scripts

/

search_auto_exclude.py

Copy path

Top

File metadata and controls

• Code
• Blame

34 lines (28 loc) · 1.36 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

#

# 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