No documentation on how to include an image in autoapi output

[taldcroft]

I have a module docstring which includes a PNG image like so:

.. image:: images/aca_timing_manual.png
  :width: 600

In this case there is a file images/aca_timing_manual.png at the same level as the main index.rst file. Using the sphinx built-in sphinx.ext.autodoc, the image is correctly included in the module autodoc output from:

.. automodule:: chandra_aca.maude_decom
   :members:

Using sphinx-autoapi, I get this error:

reading sources... [100%] api/index
/Volumes/git/chandra_aca/docs/api/chandra_aca/maude_decom/index.rst:48: WARNING: image file not readable: api/chandra_aca/maude_decom/images/aca_timing_manual.png [image.not_readable]

I have been unable to discover any documentation on how to resolve this.

[AWhetter]

AutoAPI outputs its files to a different directory. In the error you can see that it's output to docs/api/chandra_aca/maude_decom/index.rst, and is therefor expecting the image to exist at docs/api/chandra_aca/maude_decom/images/aca_timing_manual.png. Unless that path exists, you'll need to refer to the image using an absolute path (https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#images), which I'm guessing would be /images/aca_timing_manual.png assuming that docs/images/aca_timing_manual.png exists.