Copy image files when generating html pages

pdoc3 / pdoc

:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects

https://pdoc3.github.io/pdoc/

GNU Affero General Public License v3.0

1.14k stars 146 forks source link

Copy image files when generating html pages #308

Closed gunnarvoet closed 2 years ago

gunnarvoet commented 3 years ago

This pull request resolves #268. The proposed solution manages to generate html files including local copies of an image file, but falls short of passing the tests. I am creating a pull request to get some input on how to make this work for the test suite.

kernc commented 3 years ago

Sorry, I'm not decided a solution like that is in fact the preferable one. :flushed: https://github.com/pdoc3/pdoc/issues/268 is a new issue and has had no discussion/duplicates/upvotes. Personally, I'm fairly leaning to responsibility for this being deferred to maintainer shell scripts ...

gunnarvoet commented 3 years ago

I was under the impression that this was a wanted feature since #268 is labeled with 'enhancement'. If local images do not work without any additional scripts then the documentation should state this.