some tips using sphinx
conf.py
parameters.A well-known case is internationalization.
Strictly speaking we can't have a variable folder name, but this question has the answer for how we can overcome that.
By using image
directive, in example,
.. image::myimage.png
Image search will check the folder of the .rst
file for the image. Or it will use it as an absolute path if that's applicable.
ie: if the .rst location was projectname/doc/sphinx/source/core/file.rst
and we need to access
projectname/doc/doxygen/html/anotherimage.png
, we'll need to use the following
.. image::../../../doxygen/html/anotherimage.png
Unfortunately, there's no simple way for that, creating an extension specially for that is illustrated here.
Based on this SO answer we can set some constants through the .rst
. But we can't use that in directives according to this SO answer
A brief to configure conf.py.