You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When running pdoc in autoreload/preview mode, I was having trouble getting local logo images to work:
pdoc my_module --logo logo.png
Where logo.png is a file in the current directory I'm running pdoc from.
Similarly, if I create an output:
pdoc my_module --logo logo.png -o docs
I need to manually copy the logo into the output dir: cp ./logo.png docs, which makes it clear that --logo arg is a path relative to the hosted root. I cannot find a way of making a local logo work in autoreload/preview mode.
Proposal
It'd be nice when I specify a local image file, the asset is just included in the build.
Alternatives
Perhaps instead we could have a flag for --include-asset-dir or something that I could point to a directory that holds all the assets for the docs? For example, say I had a project with the following dir structure:
Problem Description
When running pdoc in autoreload/preview mode, I was having trouble getting local logo images to work:
Where logo.png is a file in the current directory I'm running pdoc from.
Similarly, if I create an output:
I need to manually copy the logo into the output dir:
cp ./logo.png docs
, which makes it clear that--logo
arg is a path relative to the hosted root. I cannot find a way of making a local logo work in autoreload/preview mode.Proposal
It'd be nice when I specify a local image file, the asset is just included in the build.
Alternatives
Perhaps instead we could have a flag for
--include-asset-dir
or something that I could point to a directory that holds all the assets for the docs? For example, say I had a project with the following dir structure:In the root project dir, I'd go
And it would copy the contents of
./assets
intodocs
:Extra context
It's very possible there's already a way to handle this that I'm just missing... if so, please let me know how I should be approaching this! Thanks.
The text was updated successfully, but these errors were encountered: