From f7bf9caa799c2eff9145bcdc5df56012dd1fe0a6 Mon Sep 17 00:00:00 2001 From: Dave Snider Date: Wed, 8 Jan 2014 16:27:00 -0800 Subject: [PATCH] update readme for sticky nav notice --- README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.rst b/README.rst index bb6f3ec0..dbb67121 100644 --- a/README.rst +++ b/README.rst @@ -73,6 +73,10 @@ Also note that the table of contents is set with ``includehidden=true``. This al to set a hidden toc in your index file with the hidden_ property that will allow you to build a toc without it rendering in your index. +By default, the navigation will "stick" to the screen as you scroll. However if your toc +is vertically too large, it revert to static positioning. To disable the sticky nav +alltogether change the setting in ``conf.py``. + Contributing or modifying the theme ===================================