Settings (Config)

Open the Settings (Config) screen ( File> Preferences> Settings ) and select Extensions> reStructuredText .

reST_doc_033.png

Preview HTML > End Task: Kill Terminal

Description

Default value

Sets whether or not to automatically close the Terminal
when building with the HTML preview function.
true

If you set the value to false , Terminal will not close.
If you want to check for errors, etc., change the value to false .

Sphinx Quick Start: Options

This is an option when using the Quick Start feature of Task.

Options

Description

Default value

Project name

Set the project name ( project )

My Document

Author name(s)

Set author name ( copyright )

Your name

Project version

Set the version of the project ( version )

1.0

Project release

Set the release for the project ( release )

1.0.0

Project language

Set the document language ( language )

en (English)

Separate source and build directories

Split the source and build directories

false

Use epub

Enable when using epub

false

Enable autodoc extension

Enable the sphinx.ext.autodoc extension

false

Enable doctest extension

Enable the sphinx.ext.doctest extension

false

Enable intersphinx extension

Enable the sphinx.ext.intersphinx extension

false

Enable todo extension

Enable the sphinx.ext.todo extension

false

Enable coverage extension

Enable the sphinx.ext.coverage extension

false

Enable imgmath extension

Enable the sphinx.ext.imgmath extension

false

Enable mathjax extension

Enable the sphinx.ext.mathjax extension

false

Enable ifconfig extension

Enable the sphinx.ext.ifconfig extension

false

Enable viewcode extension

Enable the sphinx.ext.viewcode extension

false

Enable githubpages extension

Enable the sphinx.ext.githubpages extension

false


Note

If you have any trouble, please report it to Issues. Bugs and other reports are only accepted from this page.