contents

Table of Contents

1 Examples
1.1 Title: Getting Started
1.2 Literal Command Example
1.3 Dir Command Example
1.4 toc_list Example Parent Page
1.4.1 First Child Example Page
1.4.2 Second Child Example Page
1.4.3 Third Child Example Page
1.5 Spell Command Example
1.6 Suspend Command Example
1.7 Code Command Example
1.8 Comment Command Example
1.9 Comment Character Command Example
1.10 Heading and Link Example
1.11 Sphinx ref Role Example
1.12 Indent Example
1.13 Docstring Example
1.14 Example Using TOML Configure File
1.15 Example Documenting a Class
1.15.1 An Example Using the ad_double Class
1.15.2 Run ad_double Example and Check its Result
1.16 Example Read the Docs Configuration
1.17 Template Command Example
1.17.1 First Expansion
1.17.2 Second Expansion
1.18 Test Special Conditions
2 Purpose of this Sphinx Wrapper
3 Extract Sphinx RST Files
3.1 The xrst.toml Configuration File
3.2 Extract RST Files And Run Sphinx
3.3 Commands
3.3.1 Begin and End Commands
3.3.2 Table of Children Commands
3.3.3 Spell Command
3.3.4 Suspend and Resume Commands
3.3.5 Indent Command
3.3.6 Code Command
3.3.7 Literal Command
3.3.8 Converting Sphinx Command File Names
3.3.9 Comment Command
3.3.10 Comment Character Command
3.3.11 Allow Multiple Lines in Sphinx ref Role
3.3.12 Template Command
3.4 Automatic Processing
3.4.1 Heading Cross Reference Links
3.4.2 Automatically Generated Files
3.5 Wish List
4 xrst Release Notes By Year
4.1 xrst Release Notes for 2025
4.2 xrst Release Notes for 2024
4.3 xrst Release Notes for 2023
4.4 xrst Release Notes for 2022
4.5 xrst Release Notes for 2021