suspend_example¶

Suspend Command Example¶

Discussion¶

The project_name paragraph below was taken from the xrst configure file documentation.

The documentation for the default table uses toml file format.
The python code that implements this default comes directly after and is not displayed in the documentation.

project_name¶

The only value in this table is the name of this project. The default for this table is

[project_name]
data = 'project'

xrst_code¶

The file below uses xrst_code to display the toml version of this default setting.

xrst_suspend¶

The file below uses xrst_suspend to avoid displaying the python version of this default setting.

This Example File¶

# SPDX-License-Identifier: GPL-3.0-or-later
# SPDX-FileCopyrightText: Bradley M. Bell <bradbell@seanet.com>
# SPDX-FileContributor: 2020-23 Bradley M. Bell
# ----------------------------------------------------------------------------
default_dict = dict()
r'''
{xrst_begin suspend_example}

Suspend Command Example
#######################

Discussion
**********
The project_name paragraph below
was taken from the xrst configure file documentation.

#. The documentation for the default table uses toml file format.
#. The python code that implements this default comes directly after
   and is not displayed in the documentation.

project_name
************
The only value in this table is the name of this project.
The default for this table is

{xrst_code toml}
[project_name]
data = 'project'
{xrst_code}

{xrst_suspend}'''
default_dict['project_name'] = { 'data' : 'project' }
r'''{xrst_resume}

xrst_code
*********
The file below uses ``xrst_code`` to display the toml version
of this default setting.

xrst_suspend
************
The file below uses ``xrst_suspend`` to avoid displaying the python version
of this default setting.

This Example File
*****************
{xrst_literal}


{xrst_end suspend_example}
'''