Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WARNING: image file not readable: ../../doc/uml_images/*.png #41

Open
Nic30 opened this issue Jun 6, 2024 · 1 comment
Open

WARNING: image file not readable: ../../doc/uml_images/*.png #41

Nic30 opened this issue Jun 6, 2024 · 1 comment

Comments

@Nic30
Copy link

Nic30 commented Jun 6, 2024

Hello,

images referenced from .rst file do work, however images referenced from nested python module do not.

https://app.readthedocs.org/projects/hdlconvertorast/builds/24618170/
https://github.com/Nic30/hdlConvertorAst/blob/master/doc/index.rst?plain=1#L15 this does work.
https://github.com/Nic30/hdlConvertorAst/blob/master/hdlConvertorAst/hdlAst/__init__.py#L17 this does not

hdlConvertorAst/doc$ python3 -m sphinx -T -b html -d _build/doctrees -D language=en . doc/build/html
sphinx-pyreverse: Running: pyreverse --output png --project hdlConvertorAst.hdlAst hdlConvertorAst.hdlAst
...
sphinx-pyreverse: Running: pyreverse --output png --project hdlConvertorAst hdlConvertorAst

/home/nic30/Documents/workspace/hdlConvertorAst/hdlConvertorAst/hdlAst/__init__.py:docstring of hdlConvertorAst.hdlAst:: WARNING: image file not readable: ../../doc/uml_images/classes_hdlConvertorAst.hdlAst.png
....

the file is correctly in uml_images folder

ls doc/uml_images/
classes_hdlConvertorAst.hdlAst.png     packages_hdlConvertorAst.hdlAst.png
classes_hdlConvertorAst.png            packages_hdlConvertorAst.png
...

pillow and graphviz is installed, ubuntu 24.04

$ pip3 freeze |grep -i sphinx
Sphinx==7.3.7
sphinx-bootstrap-theme==0.8.1
sphinx-pyreverse==0.0.18
sphinxcontrib-applehelp==1.0.8
sphinxcontrib-devhelp==1.0.6
sphinxcontrib-htmlhelp==2.0.5
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.7
sphinxcontrib-serializinghtml==1.1.10
@doublethefish
Copy link
Collaborator

We don’t support RST as comments in this way. Feel free to submit a PR 🤗

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants