sphinx-doc / sphinx-doc/sphinx
sphinx.ext.graphviz: custom node shape images are not copied to _images at building
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
Describe the bug
A clear and concise description of what the bug is.
To Reproduce
Steps to reproduce the behavior:
-
Start from autodoc
-
Unzip this archive in
source: graphviz_image_copy_issue.zip -
Build the doc:
make html -
Display the built doc in a browser
-
The graph doesn't display the declared image in the
customnode. -
Now copy the
film.svgfile manually intobuild/html/_images -
Refresh the documentation in the browser, the custom shape displays correctly
Expected behavior
The targetted image to be copied in build/html/_images by default.
Your project
Link to your sphinx project, or attach zipped small project sample.
Screenshots
If applicable, add screenshots to help explain your problem.
Environment info
- OS: Mac 10.14.5
- Python version: 3.7.7
- Sphinx version: 3.2.1
- Sphinx extensions: sphinx.ext.graphviz
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the issue with sphinx.ext.graphviz, the attached project archive, and make html; inspect the generated build/html/_images output and the film.svg custom node image reference. Done means the declared image is copied there automatically and the graph displays without manual file copying.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100