Sidebar navigation

quartodoc can generate a sidebar on the lefthand side of the page, with a list of your functions.

In order to create a sidebar for your docs, add the following options to your _quarto.yml:

# tell quarto to read the sidebar file
metadata-files:
  - _sidebar.yml


# tell quartodoc to generate the sidebar file
quartodoc:
  sidebar: "_sidebar.yml"
  # other options ...

Note that running python -m quartodoc build will now produce a file called _sidebar.yml, with a quarto sidebar configuration. The quarto metadata-files option ensures it’s included with the configuration in _quarto.yml.

Here is what the sidebar for the quartodoc reference page looks like:

{{< include /api/_sidebar.yml >}}