---------------------------------------
lines 6-34 of file: xrst/dir_command.py
---------------------------------------

{xrst_begin dir_cmd user}

Converting Sphinx Command File Names
####################################

Syntax
******
``\{xrst_dir`` *file_name* ``}``

Purpose
*******
Sphinx commands that use file names must specify the file
relative to the :ref:`config_file@directory@rst_directory` .
The xrst dir command converts a file name relative to the
:ref:`config_file@directory@project_directory` to be relative to the
:ref:`config_file@directory@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.

Example
*******
:ref:`dir_example-name`

{xrst_end dir_cmd}