strands-project / strands_documentation

Public documentation for the outputs of the STRANDS Project.
https://strands.readthedocs.io
MIT License
6 stars 7 forks source link

Can you move the sidebar when viewing a page #3

Open hawesie opened 7 years ago

hawesie commented 7 years ago

When I look at a page deep in the hierarchy like

https://strands-project.github.io/strands_documentation/datasets/kth_lt_labels/

It would be great if the sidebar was showing its position in the hierarchy. Is this possible with this framework? If not I think we should make the sidebar a lot sparser, otherwise its hard to navigate.

heuristicus commented 7 years ago

This should be a default feature with readthedocs, but maybe because it's being generated by mkdocs, it's not working properly?

You can see an example of how I expected it would look here: https://agda.readthedocs.io/en/v2.5.2/language/function-definitions.html#dot-patterns

heuristicus commented 7 years ago

This looks relevant: https://github.com/mkdocs/mkdocs/issues/588. Looks like it's not possible to have collapsible sidebars or scrolling sidebars with mkdocs. I've already looked into using readthedocs.io directly rather than generating the docs with mkdocs.