2024

View page source

xrst Release Notes for 2024

mm-dd

12-28

  1. Make some minor edits to the purpose page. In particular, the following text was added: once you learn xrst, you can use it for any source code language.

  2. Improve the discussion of how the template command differs from an Rst Include .

12-10

Add space below template file name, to better separate arguments, in the second xrst template command in template_example .

12-09

Correct comment about the example project_directory . To be specific, it is relative to where the config_file is located (which may not be the directory where xrst is run).

12-08

The suspend comment left, right syntax was extended from just the != operator to include the == operator. In addition, white space is now forbidden in the left and right operands.

12-01

Include the contents of the ref:template files <template_cmd@template_file> that are used below the source for each page.

11-30

Comment lines were added to the template command; see comment . Also fix some error messaging in the template command.

11-27

The left, right syntax was added to the suspend command. This makes it easier to use the suspend command inside of a template_file . The example template file was changed to use the left, right syntax instead of the boolean syntax.

10-25

Spelling errors that occurred inside a template_file were reported using the line number in the template file and the file name for the Page File . This has been fixed so that the template_file, template_line, page_file, and page_line are all reported.

10-01

MacOS python has an issue that was causing xrst to abort; see urllib3 issue 3020 . This has been changed so that xrst only prints a warning when this is the only warning or error message.

09-09

The development and install tools were extended to work well on MacOS with homebrew. The versions between 08-25 and 09-08 were not tested and may have trouble on other systems. (There was a problem with the new bin/grep_and_sed.sh script.)

08-25

Comment out the choice of the pyenchant in the example configuration file; see the heading Example under spell_package . This was done because pyenchant is harder to set up on some systems.

08-13

The syntax for the literal command was split into the Entire File , With Separator , and Without Separator cases.

08-12

Change the get_started example to use an empty xrst.toml configuration file. In addition put xrst.toml in the page for the configuration file (so that it comes up when you search for xrst.toml).

06-25

It used to be the case that the following input would cause xrst to crash in the file auto_indent.py:

{xrst_begin empty_page}
{xrst_end   empty_page}

This has been fixed.

04-30

Remove the testing wish list item because xrst is now tested on window, ubuntu, and macos using a github workflow.

04-06

  1. Add the boolean argument to the suspend command and allow for suspend and resume commands in a template_file .

  2. Sphinx errors messages that occurred inside a template expansion were reported using the page file and template line. This has been fixed and they are now reported with the page file, page line, template file, and template line.

04-05

Change the default display_file in the literal command from the current Input File to the current Page File . This only changes the literal command when it is used in a template file (template commands became available on 03-28).

03-30

  1. The automatic special spelling words for a page were extended to include page names in :ref: commands; see page_name . In addition, the words in page_name , that are displayed by this :ref: command , are checked for double word errors.

  2. The keywords in the xrst search utility excluded the words that matched not_in_index . This has changed so that the keywords include all the words in a page title or heading.

  3. Duplicates were removed form the html keyword meta data. In addition, commas (instead of spaces) where used to separate these keywords (because that seems to be the standard).

03-29

  1. Add a Spelling example in the example template expansions.

  2. Back out change in definition of double word errors.

03-28

  1. Add the template command and template_example .

  2. Change the definition of double word errors so that it only refers to the xrst input file, not the output that the user sees.

03-19

Add the external_links option to the xrst command line.

03-16

Add the template command to the wish list. This was completed; see 03-28 above.

03-04

  1. The table of contents page was moved from xrst_table_of_contents.rst to xrst_contents.rst . In addition, links were added to the page name. Old links to the page title had the form:

    :ref:`xrst_table_of_contents-title`

    These links need to be changed to:

    :ref:`xrst_contents-title`

  2. The pages with names that begin with xrst_ were modified to make the names, titles, and linking text more consistent; see xrst_contents.rst , xrst_search.rst , xrst_index.rst , Also see the discussion of linking text for a page_name .

03-02

There was a bug in the xrst search page (introduced on 2024-02-29). To be more specific, the search was loading the page before the one selected. This has been fixed.

03-01

The Install From Source instructions were improved.

02-29

The name of the xrst search page was changed from Search to xrst_search and its link was moved to directly below the sphinx Search link. This distinguishes it from the search that comes with sphinx. The xrst search page was displaying the number of matches displayed, which is at most 100, instead of the total number of matches. This has been fixed. In addition, you can now link to the xrst search using either:

:ref:`xrst_search-name`
:ref:`xrst_search-tilte`

02-25

A discussion was added for the case where the file list is Empty in a toc command. In addition, the error message was improved for the case where this list is empty and the page is not a parent page.

02-14

If xrst could not translate an error message from its rst line number to its original input file, a non-zero error flag was set and just a newline printed to stderr. This has been fixed and a more meaningful error message is printed before the program exists.

02-03

Adapt pytest/test_rst.py so the tests work on windows and extend tox.ini so that versions from 3.8 to 3.12 are tested.

01-29

Add the ignore_spell_commands option to the xrst command line.

01-21

  1. If you used docstring_example for a page_name and there was a spelling error in that page, xrst would stop at a breakpoint before reporting the spelling error. This has been fixed.

  2. It was possible for the assert below to fail. This has been changed into an error message:

    assert page_name == 'xrst_table_of_contents'

  3. The information and suggestions printed below the spelling warnings has been improved.

01-04

A link to the current release was included; see Versions .

01-01

  1. The get_started example was simplified by using the stable release for 2024.

  2. A stable version of the documentation was created; see Versions .

  3. Each file_name in the latest documentation was moved (this is important if you have links to previous web pages):

    Old Location

    https://xrst.readthedocs.io/file_name

    New Location

    https://xrst.readthedocs.io/latest/file_name