auto_file

View page source

Automatically Generated Files

  1. These files are located in the rst_directory .

  2. A new version of these files is created each time xrst is run.

  3. The files in the rst subdirectory that do not change are not replaced. (This reduces the amount of processing that sphinx needs to do.)

  4. All these files have the .rst extension with the exception of conf.py and xrst_search.js .

conf.py

This is the sphinx configuration file. It is the only file in the rst_directory directory that is not an rst file.

xrst_root_doc.rst

This file is the top of the documentation tree built by sphinx. It is one level above the first page in root_file.

xrst_contents.rst

This file contains the table of contents for the last run of xrst. You can link to the corresponding page name contents or page title Table of Contents with the following commands:

:ref:`xrst_contents-name`
:ref:`xrst_contents-title`

xrst_index.rst

If target is html, this file contains a link to the table of contents generated by sphinx. You can link to the corresponding page name or page title with the following commands:

:ref:`xrst_index-name`
:ref:`xrst_index-title`

The xrst_index.rst file is not created when target is tex.

xrst_search.rst

If target is html, this file contains the xrst search utility for the last run of xrst. A link to this search utility appears at top left side of each web page. You can place a link to this page name or page title using the following commands:

:ref:`xrst_search-title`
:ref:`xrst_search-name`

This page tile will start with the project_name (which for this documentation is xrst ). The xrst_search.rst file is not created when target is tex.

xrst_search.js

This file is used by xrst_search.rst.