Skip to main content Skip to navigation

ReText on Windows

There are no WYSIWIG editors for reStructuredText .rst files, the best that appears to be available is the Python module ReText

This can be installed within a Python environment on Linux or Mac using "pip3 install ReText".

Windows now supports Python as an app. ReText can then be installed from the command line using "pip install ReText", however the icons for the app are missing. This is a known problem which can be solved as follows:

I have created a Python package from the current code which does work with icons and can be downloaded from here, unzipped and placed into the directory:

C:\Users\<username>\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.9_<installation specific text>>\LocalCache\local-packages\Python39\site-packages\

This is made up of the application files from: https://github.com/retext-project/retext/tree/master/ReText with the icons from https://github.com/retext-project/retext/archive/icons.tar.gz added to the icons directory.

ReText can then be launched from the Windows command line using "python -m ReText", perhaps done from a batch file on the desktop. If that meets your needs then nothing more needs to be done. However, if you want it to launch seamlessly from the start menu, create a batch file:

cd c:\%HOMEPATH%\Documents  
python -m ReText

and place it in the directory C:\ProgramData\ReText. Create a shortcut to the batch file (Select file, Right click, "Create shortcut"), and rename the shortcut "ReText". To give it an appropriate icon, right click the shortcut, select change icon and select the icon file:

"C:\Users\<username>\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.9_<installation specific text>\LocalCache\local-packages\Python39\site-packages\ReText\icons\retext.ico"

At the same time, the shortcut can be set to 'Start minimised'. The shortcut should then be copied into:

C:\Users\<username>\AppData\Roaming\Microsoft\Windows\Start Menu\Programs

After windows has been restarted then ReTExt will appear in the program list from the start menu and it can be made available as a tile by right clicking on it and selecting "Pin to start".

Note that it does not appear to be possible to start with pythonw (which does not create a console window) as this prevents the preview from appearing. Note also that the drop down menus for formatting etc only work when editing a markdown document and are not supported for .rst documents because the formatting markups for .rst documents are a mess.