search

NiklasRosenstein / pydoc-markdown

Create Python API documentation in Markdown format.
http://niklasrosenstein.github.io/pydoc-markdown/
Other
460 stars 105 forks source link

Images in readme.md #32

Closed Peter554 closed 4 years ago

Peter554 commented 6 years ago

So when I add images to the readme.md with e.g.

<img src='demo/Tumor_004_thumb.png' width='20%'/>

they are correctly rendered on the repo github page. However, in the generated docs the links/images seem to broken? Is this a feature we can fix/add?

NiklasRosenstein commented 6 years ago

This is definitely something that should be fixed, or rather added as a feature as it can hardly be a bug when there is no code to handle the case. 😃

sverch commented 6 years ago

I ran into a similar issue. Part of the problem is that I wasn't sure how to get pydocmd to copy the images in since it only copies markdown files from docs_dir. So I made https://github.com/NiklasRosenstein/pydoc-markdown/pull/56 to copy all files from docs_dir. With that you can symlink any images into that directory that you want pydocmd to copy and it seems like it works.

NiklasRosenstein commented 4 years ago

Closing in favor of #94