Skip to content Skip to sidebar Skip to footer

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

Solution 1:

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?

Solution 2:

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

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

Post a Comment for "Sphinx Exclude One Page From Html_sidebars"