CODEWITHSUNDEEP
configurationpython-sphinxglob
bgrantdev
bgrantdev

Reputation: 1672

Sphinx exclude one Page from html_sidebars

I am using Sphinx to build user docs for an application. According to the documentation for build configuration file there is an html_sidebars setting with an example documentaion.

html_sidebars = {
'**': ['globaltoc.html', 'sourcelink.html', 'searchbox.html'],
'using/windows': ['windowssidebar.html', 'searchbox.html'],
}

I am looking to have all pages display the sidebar except one, I have only been able to achieve the inverse of that, where the sidebar appears on just one page and not the rest.

html_sidebars = {'index': ['localtoc.html']}

I know that its possible to use glob syntax and I've tried almost every variation of [!index] I can think of without success.

Upvotes: 1

Views: 751

Answers (2)

Chris Bay
Chris Bay

Reputation: 21

I had the same issue, and was able to achieve the desired result using:

html_sidebars = {
    '**': ['localtoc.html'],
    'index': []
}

Upvotes: 2

Steve Piercy
Steve Piercy

Reputation: 15035

You will need to have your expression match everything except the string 'index'. Unfortunately globbing is not that flexible. There are several ways of working around it.

  1. explicitly list each file except index
  2. rename the files that you want to have the sidebar with a prefix or suffix, and use a corresponding globbing pattern to match only those files
  3. move the files into a subdirectory, and use a corresponding globbing pattern
  4. try [!x], assuming no other file has "x" in its name (i, n, d, and e are too common)
  5. possibly something else?

Upvotes: 2

Related Questions