1. Robert Lehmann
  2. sphinx-sidebar

Commits

Robert Lehmann  committed 622af70

Clarified document output and javascript obscurities.

  • Participants
  • Parent commits 00966f7
  • Branches default

Comments (0)

Files changed (1)

File doc/ext/sidebar.rst

View file
  • Ignore whitespace
 .. versionadded:: 1.0
 
 Build a table of contents HTML document suitable for use as a Mozilla/Netscape
-sidebar.
+sidebar. These files are generated as part of the HTML build process and end
+up at the top level of your build directory, called similar to ``toc-``\ *name*\
+``.html``.
+   
+By default, sections only grow a navigation sidebar if they have at least one
+cross-reference to another document in their toctree.
+
+.. note:: Javascript does not allow panels to be loaded from local files
+          (``file://`` protocol) for security reasons. Otherwise adding panels
+          only works in Mozilla, Netscape and Firefox.
 
 .. confval:: sidebar_all
 
-   Sections only grow a navigation sidebar if they have at least one
-   crossreference to another document in their toctree. This setting overrides
-   the heuristic to include all sections (even those with only internal anchor
-   links) in the build process.
+   This setting overrides the heuristic to include all sections (even those
+   with only internal anchor links) in the build process.
 
 .. confval:: sidebar_excludes