|
| 1 | +Changes regarding the Sphinx plot directive |
| 2 | +``````````````````````````````````````````` |
| 3 | + |
| 4 | +Fixed a bug in the Sphinx plot directive (.. plot:: path/to/plot_script.py) |
| 5 | +where the source Python file was not being found relative to the directory of |
| 6 | +the file containing the directive. In addition, its behavior was changed to |
| 7 | +make it more streamlined with other Sphinx commands. |
| 8 | + |
| 9 | +Documents that were using this feature may need to adjust the path argument |
| 10 | +given to the plot directive. Two options are available: |
| 11 | +1. Use absolute paths to find the file relative the ``plot_basedir`` (which |
| 12 | + defaults to the directory where conf.py is). |
| 13 | +2. Use relative paths and the file is found relative to the directory of the |
| 14 | + file containing the directive. |
| 15 | + |
| 16 | +Before this change, relative paths were resolved relative to the source |
| 17 | +directory (where conf.py is) and absolute paths were pointing to files in the |
| 18 | +host system. |