Skip to content

How to use Custom Banner Image instead of Github Banner #222

@pique-b

Description

@pique-b

In my Sphinx documentation I am using the Alabaster theme.

Now, for the purpose of adding my own banner image (ref document, I have added 'github_banner': True in html_theme_options in my conf.py.

Again, refering to the same section of the document (cited above), it says:

May also submit a string file path (as with logo, relative to $PROJECT/_static/) to be used as the banner image instead of the default.

which I am intending to do.

However, I am unable to find a way as to how may I submit a string path for the custom banner image.

To repeat, where exactly the custom banner image path needs to be added?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions