StarMirror/sol2
1
0
Fork 0
mirror of https://github.com/ThePhD/sol2.git synced 2024-03-22 13:10:44 +08:00
Code Issues Projects Releases Wiki Activity

update readme for sticky nav notice

Browse Source
This commit is contained in:
Dave Snider 2014-01-08 16:27:00 -08:00
parent 17f17ee6aa
commit f7bf9caa79
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.rst
View File

@ -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 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. 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 Contributing or modifying the theme
=================================== ===================================