@Blendify I'm taking the confidence to mention you here since you are one of the main maintainers of Read the Docs Sphinx Theme. It would be awesome if you could take a look at these changes when you have some time and give some feedback to mkdocs folks here.

I really appreciate your help.

You can just ignore this notification and that's fine. I'm sorry to bother you.

There is no need to feel sorry, I am glad to help. I will take a look.

Some toc options were not included these include:

• includehidden = True
• collapse_navigation = True
• sticky_navigation = True

Is there a reason these are not supported?

Some toc options were not included these include:

• includehidden = True

MkDocs' concept of hidden pages is very different from Sphinx and therefore this option makes no sense. As I understand it, Sphinx page objects include a hidden attribute. MkDocs page object have no such attribute. A hidden page is simply not included in the nav at all. Therefore, there is no way to include such pages.

Or am I misunderstanding the purpose of this setting?

• collapse_navigation = True
• sticky_navigation = True

I haven't worked on these. Basically, I need to determine what is different about the HTML with these options enable/disabled and add the same logic to our template. Personally they are not high priority items so I haven't got to them yet. And the assumption is they could always be added at any time.

stick_navigation has been added.

I'm struggling to see the difference between collapse_navigation and titles_only. The documentation seems clearly different, but in practice both setting simply exclude TOC items from the nav. As I already implemented that feature in titles_only, what value is there is also adding collapse_navigation ?

As an aside, the documentation for collapse_navigation states:

• collapse_navigation Bool. With this enabled, you will lose the [+] drop downs next to each section in the sidebar.

But that is not strictly true. You still get [+] drop downs, just not as many levels of them (tested with the docs in rtfd/sphinx_rtd_theme). I find that very misleading and its not something I'm inclined to replicate... unless someone can explain to me the value of the setting and/or what it is supposed to be doing.

Hmm, our docs are a bit miss leading. http://www.sphinx-doc.org/en/stable/templating.html#toctree explains these options better.

@Blendify thank you. Those docs are must more clear. I now have the following implemented:

• include_homepage_in_sidebar: Lists the homepage in the sidebar menu. As
  MkDocs requires that the homepage be listed in the nav configuration
  option, this setting allows the homepage to be included or excluded from
  the sidebar. Note that the site name/logo always links to the homepage.
  Default: True.

• prev_next_buttons_location: One of bottom, top, both , or none.
  Displays the “Next” and “Previous” buttons accordingly. Default: bottom.

• navigation_depth: The maximum depth of the navigation tree in the
  sidebar. Default: 4.

• collapse_navigation: Only include the page section headers in the
  sidebar for the current page. Default: True.

• titles_only: Only include page titles in the sidebar, excluding all
  section headers for all pages. Default: False.

• sticky_navigation: If True, causes the sidebar to scroll with the main
  page content as you scroll the page. Default: True.

I will take another look again, but from my first look over, it looked pretty good.