2023

View page source

xrst Release Notes for 2023

mm-dd

12-23

Change the python comment delimiter from """ to r""" in the following examples: code_example , indent_example , and testExample .

12-20

Improve the get_started example.

12-19

Improve the summary message about spelling warnings.

12-17

  1. The discussion of the spell command project_dictionary was improved. In addition, a list of all the misspelled words if included after the spelling warnings as a suggestion for the project dictionary.

  2. A copy button was added to the all displayed code. This added the sphinx-copybutton to the Dependencies .

12-10

The indent command was added so that the amount of indentation could be different for different parts of a page; e.g. see xrst_indent .

12-06

  1. An example that documents a class was added; see class_example .

  2. The comparison between xrst with doxygen and autodoc was made more explicit; see Goal .

  3. The pound sign # and the dash character - were added to the list of characters allowed in the web address that do not get spell checked.

12-04

Words in the current page_name are now automatically consider correct spellings and are no longer needed in the spell command. If this causes a lot of spelling warnings for a project, consider using replace_spell_commands to fix them.

11-21

Add mention in purpose of the new xrst_search web page.

11-20

The program would crash after reporting warning or error when the rst_line_numbers option was present on the command line. This has been fixed.

11-15

Add the xrst_search web page.

10-18

Allow for newlines in sphinx ref role targets; see ref_cmd .

10-09

  1. The following problem has been fixed. If page_source was not present on the xrst command line, and target was tex, the program crashed with the message:

    UnboundLocalError: cannot access local variable 'data_out' ...

  2. When page_source is present and target is tex , the location of the page source file name was changed so it stands out.

  3. When target was tex , and there were dash characters - in a page_name , a cross reference to page_name-name would fail. This has been fixed.

10-08

There was a bug in the conversion of error messages from the extracted rst file location to the location in the original source file. The converter did not recognize a page_name that had capital letters, A-Z, or the dash character, - . This has been fixed.

10-07

Change html theme from sphinx_book_theme to furo because sphinx book theme does not support as many levels; see sphinx_book_theme issue 603 .

10-01

There was a bug in the replace_spell_commands option. To be specific, the program would halt with the following message:

... line 92, in replace_spell
data_copy = xrst.add_line_numbers(data_copy)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
... add_line_numbers() missing 1 required positional argument: 'file_in'

This has been fixed.

09-28

Change the get_started example to install the current test version of xrst.

09-07

  1. Change python doc strings form using ''' and """ to using r''' and r""" ; e.g, see docstring_example . This avoids python syntax highlighting in the documentation code (in some editors).

  2. Remove the ''' form the This Example File because it is not a python file and so does not need them.

08-24

  1. The Discussion about labels being verbose was improved by splitting the corresponding item into sub-items.

  2. The comparison between xrst literal command and the sphinx literalinclude directive was improved. To be specific, the following paragraph was added: ‘It is possible to specify multiple sections of a file using the start after and end before patterns …`

08-23

If there is an undefined label, that could not be an xrst label , then following message is added to the warning:

The label above does not contain an @ or end with -name or -title.
Hence it is not automatically generates by xrst.

08-17

Add a link for Read the Docs configuration file specification .

08-14

  1. The Discussion of the html location corresponding to a heading was improved. To specific, “an html heading location is still valid after changing its documentation and/or source code locations” .

  2. The optional order argument was added to the table of children command.

07-19

Make the .inextension a special case in the literal command.

07-17

Fix spell checking inside new version of literal command.

07-16

Add an optional separator to the literal command.

07-15

  1. Make it an error for the following text to appear in an input file:

    @xrst_line number

    where number is an integer. (This pattern used is used to report line numbers in error messages.)

  2. A check was added that will report an error when the text {xrst_ is not the beginning of a recognized command and it is not preceded by a backslash.

07-10

  1. Fix the xrst --help message for the rename_group option.

  2. Make the order of the xrst --help output the same as in the command Syntax .

07-02

  1. Move all the command line true / false flags to the beginning of the xrst Syntax ; e.g., --rst_only .

  2. Add the number_jobs command line argument (for parallel processing).

06-04

Fix some spelling errors found when changing pyspellchecker from version 0.7.0 to 0.7.2.

05-27

  1. Remove the build package from the required packages (not even needed for testing).

  2. Remove the shebang from the xrst/run_xrst.py file because it is not directly executed at the shell command line.

05-03

Improve the error message when there is more than one toc_cmd in a page.

04-12

The Discussion paragraph of the comment character example was improved.

04-02

The xrst --help message was reporting the wrong help for --rst_only. This has been fixed. In addition, the rst_only documentation has been improved.

03-08

The program used to abort when a toc_cmd did not specify any files. In the special case where the current page starts with begin_parent , an empty file list can be useful to specify the location of the child links and the type of children; i.e., hidden, list, or table.

02-19

Add the continue_with_warnings command line option.

02-05

Improve the Install Testing Version instructions so that it properly fetches the xrst dependencies.

01-23

  1. If you had a toc_cmd with no files, e.g. {xrst_toc_hidden} , the program would crash with the message below. This has been fixed by printing a useful error message in this case:

    assert m_child is None

  2. The .readthedocs.yaml example file was modified to show how to use the most recent testing version of xrst.

01-22

Add the suppress_spell_warnings command line option.

01-19

Add the heading configuration file option. This can be used to check that all the pages in a project use the same underline and overline conventions.

01-12

  1. Include a temporary fix for the dependency problem by including a setup.py file. This will no longer be necessary when setuptools gets the dependencies right.

  2. Change the Development Status in pip from Production to Beta.

  3. Simplify .readthedocs.yaml (now the dependency problem has been fixed).

01-10

  1. Modify the wish list Testing item (completed on 2024-04-30) now that tox and pytest are used to test versions of python.

  2. Switch from using hatchling to setuptools as the backend for building this project.

  3. Add following discussion to install instructions (it has since been removed). The pep-621 standard is for the dependencies to be in the pyproject.toml file. Some older versions of setuptools do not yet handle these correctly and you may need include some of the dependencies on the pip install command line; see Dependencies .

01-08

  1. Add the pytest directory and instructions for using it under Install From Source .

  2. Add the spell_package configure file option.

01-06

  1. The dash characters - was added to the characters allowed in a page_name . This change will be included in version 2023.0.2. The page name user_guide was changed to user-guide as a demonstration of using dashes in page names.

  2. Change the index.html file in the html_directory to be a copy of the index_page_name html file instead of a redirect to it. This was done because firefox cached the redirect and you could not change it without clearing all the cache.

01-05

Edit the RST Command File Names wish list entry.

01-03

Add the Spell Checking wish list item.

01-02

  1. If you ran xrst twice with the sphinx_rtd_theme, you would get a warning that xrst could not modify the widths in the theme. This has been fixed (and will be included in version 2023.0.2).

  2. Add Install From Source instructions and add more discussion to the other installs.

01-01

Tried to change the html_theme in .readthedocs.yaml from furo to sphinx_book_theme to get better coloring of code font; see git hash 2bea5b4fc . This generated a sphinx crash on readthedocs .