search

airtai / nbdev-mkdocs

Extension to nbdev for generating docs with Material for Mkdocs
https://nbdev-mkdocs.airt.ai
Apache License 2.0
17 stars 2 forks source link

`sidebar.yml` gets overridden every `nbdev_mkdocs preview` #174

Closed BirkhoffG closed 1 year ago

BirkhoffG commented 1 year ago

sidebar.yml under the directory nbs gets overridden every nbdev_mkdocs preview.

I cannot manually specify my sidebar.

Reference: https://github.com/BirkhoffG/jax-dataloader/pull/15/commits/0030b35a80ba87d21f429fc46147be727ce61b7e

harishmohanraj commented 1 year ago

Hi @BirkhoffG

Please try setting custom_sidebar = True in the settings.ini file and running the nbdev_mkdocs preview command. This will prevent sidebar.yml from being regenerated each time you rebuild your docs.

By default, nbdev generates the sidebar.yml file based on the directory structure of your source files during each doc build. However, if you wish to create a customized navigation sidebar, you must set custom_sidebar = true in your settings.ini file.

You can find more information on this in the nbdev documentation here: https://nbdev.fast.ai/explanations/docs.html#customizing-the-sidebar

BirkhoffG commented 1 year ago

Thanks @harishmohanraj