\(\newcommand{\B}[1]{ {\bf #1} }\) \(\newcommand{\R}[1]{ {\rm #1} }\)
dir_cmd¶
View page sourceConverting Sphinx Command File Names¶
Syntax¶
{xrst_dir file_name }
Purpose¶
Sphinx commands that use file names must specify the file relative to the rst_directory . The xrst dir command converts a file name relative to the project_directory to be relative to the rst_directory .
file_name¶
Is a file name relative to the project directory. The entire command gets replaced by a name for the same file relative to the rst directory. Leading and trailing white space in file_name is ignored.