Options for generating the Sphinx .rst files from a Word document¶
The following options are effective whenever you generate the Sphinx .rst files (Alt+s)
Option |
Definition |
---|---|
CodeStyle=style |
Define the style for the CodeStyle processing |
WholeSite=yes|no |
Controls whether to delete old generated files before generating new ones ? |
Index=style[,style…] |
Define styles that are to be automatically indexed |
NoteStyle=style |
Define the style for the NoteStyle processing |
Section=style[,style…] |
Define styles that are considered section headers |
SidebarWidth=width |
Define the width of the sidebar (units can be anything accepted by css) |
SidebarBackground=color |
Define the color of the sidebar background |
Title=style |
Define the style for Title processing. |
TocDepth=n |
The nesting depth used in the tables of contents |
ShowTOC=yes|no |
Set the Sphinx ‘hidden’ flag on a toctree (to hide the toc) |
TOCTree=style[,style…] |
Define styles that create toctrees |