Build to HTML / Preview

This extension allows you to display a preview of the HTML next to the text editor. Also, when you save a file with the preview mode enabled, it will automatically start building and update the view.

reST_doc_012.png

Procedure

  1. Select and open a file in rst format

    reST_doc_007.png

  2. Click on the triangle symbol that appears in the upper right corner of the panel

    reST_doc_019.png

  3. Select one of the following items: Preview HTML [Built-in build] (currently only available on Windows) or Preview HTML [User env build] .

    reST_doc_008.png

    • [Built-in build] : Build using the executable file included with the extension

    • [User env build] : Build using the Sphinx environment installed on the user’s machine.

      See also

      See Build for details.

  1. When the build is executed, the execution status will be displayed in the Terminal, which will automatically close when it is finished.

  2. On the right side of the editor, you will see a preview of the built HTML

Automatic Updates

  1. Change the contents of the rst file and save it

    • The build will start automatically and the preview screen will be updated

  2. Close the preview screen panel when exiting the build or preview

Note

Running Preview HTML [Built-in build] will execute the file sphinxhelper.exe , which is included with the extension. Please allow the execution of this file, as it may be restricted by your security software.

The original file/program of this exe file is available on GitHub .

See also