Potential workaround for custom API TOC page

[banchan86]

Hi @glopesdev @cjsha @bparks13 I learned something that may be helpful for you guys.

I stumbled upon this earlier when trying to replicate the TOC on the old Bonvision Docs but I had trouble getting it to stick as docfx will automatically generate the api/toc.yml file on build. I recently figured out how to do it and you can see a preview of this at https://banchan86.github.io/BonVision_env_dev/api_landing/api_landing.html.

What I found out was that you can point the API page to another folder with a custom toc.yml, and if you add api/toc.yml to the "build -> exclude" section of docfx.json, it will not use it to generate the sidebar TOC. It will still automatically generate api/toc.yml though so its still necessary to point the API navigation link to another folder.

"build": {
  "content": [
    {
      "files": [
        "**/*.{md,yml}"
      ],
      "exclude": [
        "_site/**",
        "filter.yml",
        "bonsai/**",
        "api/toc.yml"
      ]
}

Without this section in docfx.json, even though the custom API TOC page works at first, if you click on any of the operators its resets to the automatically generated TOC.

This may be another option to consider for you guys in addition to the one that I know @glopesdev was exploring over at dotnet/docfx#9998.

[banchan86]

Closing this issue because its not relevant anymore due to bonsai-rx/docfx-tools#6