numere-org / NumeRe

Framework for numerical computations, data analysis and visualisation
https://www.numere.org
GNU General Public License v3.0
17 stars 5 forks source link

Add possibility to include created plots in PDF documentation #197

Open numeredev opened 4 months ago

numeredev commented 4 months ago

DESCRIPTION

Is your change request related to a problem? Please describe. Although it is in principle possible to include images in the PDF documentation using LaTeX commands, that is quite tedious as it requires to give the absolute path and does not allow using placeholders.

Describe the solution you'd like Provide at least a simple doc keyword like \insertplot "FILE" "CAPTION", which will include the graphic FILE at its position using the caption CAPTION. This keyword shall not be part of the internal documentation or converted to something like [Image].

Describe possible alternatives you've considered A clear and concise description of any alternative solutions or features you've considered, if any.

Additional context Add any other context or screenshots about the feature request here.

(Do not write below this line)


DEVS' SECTION

ANALYSIS

(Describe, what's the issue and which changes have to be made)

IMPLEMENTATION STEPS

(see also our Wiki for implementation guidelines)

DOCUMENTATION STEPS

(see also our Wiki for further information)

PULL REQUEST