Add breadcrumb navigation

[pradyunsg]

Discussed in #139

[bgmeulem]

I'm starting out with sphinx and custom theming, so I don't feel comfortable filing a PR yet, but this can be achieved with custom templates using something like below.

{% set parent_module = obj.id.split('.')[:-1] | join('.') | escape %}

.. breadcrumb:

{% if parent_module %}
Back to :mod:`{{ parent_module }}`
{% endif %}

.. title:

{{ obj.short_name }}
{{ "=" * obj.short_name | length }}

[pmichaud]

I'm starting out with sphinx and custom theming, so I don't feel comfortable filing a PR yet, but this can be achieved with custom templates using something like below.

{% set parent_module = obj.id.split('.')[:-1] | join('.') | escape %}

.. breadcrumb:

{% if parent_module %}
Back to :mod:`{{ parent_module }}`
{% endif %}

.. title:

{{ obj.short_name }}
{{ "=" * obj.short_name | length }}

I'm also new to Sphinx and to theming -- where would the above go to make it work...?

Pm

[bgmeulem]

Hiya

these would go in the Jinja templates. Which templates that are used depend on your extensions. i use sphinx-autoapi as I like it a lot more than autosummary. You can set up your documentation to use custom templates in your conf.py file, but the exact setup again depends on whether you use e.g. sphinx-autoapi or autosummary...
I followed this post to set up my sphinx-autoapi generated documentation with furo: https://bylr.info/articles/2022/05/10/api-doc-with-sphinx-autoapi/#basic-macro-setup

This has nothing to do with furo though, and I see there is an open PR that may achieve the same thing entirely. Maybe it's also worth simply waiting for the PR to be merged.

Cheers
Bjorge