Skip to content

Correct the locations of images in the HTML documentation and tutorials.

Chris Cantwell requested to merge ccantwel/nektar:fix/doc-images into master

Issue/feature addressed

When generating HTML user guide, developer guide or tutorials, some or all images are placed in the top-level img directory, which is not where the generated HTML expects them to be (it expects them to be in sub-directories matching the source latex). In addition, those images in EPS were not being converted to PNG.

An example of the problem can be seen at the bottom of this page.

Proposed solution

Put the files in the locations expected by the generated HTML. Add EPS conversion.


The GLOBing for images is now done with respect to a base path, so that a list of relative paths instead of absolute paths is obtained. Instead of stripping the directory, this relative path is used to put the file in the correct sub-directory in the target location. The tutorials have separately been updated to also perform conversion of EPS and PS files. However, in this MR, we update the Dockerfiles used for the CI and packaging to permit the conversion of EPS and PS files in addition to PDFs.


Not applicable.


This MR also updates the commit for the tutorial sub-module.


  • Functions and classes, or changes to them, are documented.
  • User guide/documentation is updated.
  • Changelog is updated.
  • Suitable tests added for new functionality.
  • Contributed code is correctly formatted. (See the contributing guidelines).
  • License added to any new files.
  • No extraneous files have been added (e.g. compiler output or test data files).


On the 19.07 the code formatting (code style) was standardised using clang-format, over the whole Nektar++ code. This means changes in your branch will conflict with formatting changes on the master branch. To resolve these conflicts , see #295 (closed)

Edited by Chris Cantwell

Merge request reports