phpDocumentor / phpDocumentor/phpDocumentor

Issue with copy images to output directory

Open
#3,635 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Guides/RestructuredText
Dominant language
PHP
Stars
4.3k
Forks
648
Avg merge
28m
Merged PRs (30d)
13

Description

Coping images linked in rst files are giving an error:

[error] Unable to write file "/guides/docs/cli/first-docs.png", Impossible to create the root directory "/opt/project/build/docs/guides/docs/cli". mkdir(): File exist

Expected behavior

Image should be linked correctly

Actual behavior

Error is reported image is not copied. The output html looks fine.

Steps to reproduce the problem

  1. add an image directive to an rst file and link it to an existing image
  2. run phpdoc

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the issue with an rst file that uses an image directive pointing to an existing image, then run phpdoc and inspect the reported output path. Investigate the image-copying entry point responsible for creating the output directory. Done means phpdoc completes without the mkdir error and the image is copied and linked correctly in the generated HTML.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.