wish_list¶

Wish List¶

The following is a wish list for future improvements to run_xrst. If you want to help with one of these, or some other aspect of xrst, open an xrst issue .

Spell Checking¶

Spell checking not require a special word for any valid role names; .e.g, the following text should not require a special spelling entry for samp

:samp:`print 1+{variable}`

Testing¶

Use github actions to test xrst on multiple systems. Note that tox and pytest are used to test xrst in different versions of python. The following is the tox.ini file for xrst:

# SPDX-License-Identifier: GPL-3.0-or-later
# SPDX-FileCopyrightText: Bradley M. Bell <bradbell@seanet.com>
# SPDX-FileContributor: 2020-23 Bradley M. Bell
#
[tox]
# see python requires-python in pyproject.toml
envlist   = {py3.12, py3.11, py3.10}
skipsdist = true

[testenv]
deps     =
   pytest
   toml
   pyspellchecker
   pyenchant
#
commands = pytest -s pytest

Theme¶

It would be nice to have better Default options for more themes so that they work will with xrst.

sphinx_rtd_theme¶

It would be nice if there were a way to make this theme use more horizontal space (currently xrst tires to modify its output to do this).

sphinx_book_theme¶

The sphinx_book_theme seems to crash sphinx on readthedocs; see the heading 01-01 in the release notes for 2023.

Search¶

It would be nice for the search to only match pages that index all of the words entered into the search box. It would also be nice if each matching page had a list of all its index words below the corresponding page name. (In xrst, the Index words are all words that appear in headings in the page.)

RST Command File Names¶

It would be nice if all commands in the rst files used file names were automatically mapped so they were relative to the project_directory . If this were the case, one would not need the dir command . In addition, the file names should not be checked for spelling (this is already true for the ref role).

Tabs¶

Tabs in xrst input is not tested because tabs in a code blocks get expanded to 8 spaces; see stackoverflow. Perhaps we should add a command line option that sets the tab stops, convert the tabs to spaces when a file is read, and not include tabs in any of the processing after that.