Options for creating the Sphinx environment

The following options are used whenever you generate the Sphinx environment (Alt+Shift+S).

Option	Definition
BodyHead	Additional HTML added to the start of each page. Eg for adding styles, JavaScript etc.
BodyTail	Additional HTML added to the end of each page.
BuildPath=path	Location where the final output will be saved (eg path/html) Default: OutPath/_build (the sphinx default)
Copyright=text	Define the copyright message that will be shown on your website footer Default: “Copyright (c) <year>, <author> with the author taken from the document properties.
CSS=css text	Include some additional CSS
excludeDirs=dirlist	List of folders that Sphinx should ignore. (_html is always ignored). Default: none Note: The list needs to be folder names in single-quotes separated by commas.
favicon=filename	An icon file that will be used for the website’s favicon Default: none
Language=code	Set the Language for the Sphinx base text. See language option in www.sphinx-doc.org/en/master/usage/configuration.html Default: en
logo=filename	An image (best smaller than 200x200) that will appear in the navigation panel Default: none
Navigation=top::bottom	Control the top and bottom navbars. Default is the sphinx default with next|previous|index. Options: default, none, or your own html. Note: the separator is a double colon. Note: not all themes have navbars.
OptionOutPath OutPath=path	Location of ghe Sphinx environment and where the generated .rst files will be saved. You need to run make html from this folder. Default: folder of the Word document
ProjectTitle=text	Specify the title that will be shown at the top of the website Default: name of Word Document (without path or extension)
SideBars=names	Define the sections that will appear in your websites side bar. Default: relations,globaltoc,searchbox Relations are Previous/Next buttons GlobalTOC is the global table of contents SearchBox is the search box Note: not all sections are shown in all themes.
ThemeName=theme	Set the theme. Eg sphinx_rtd_theme Default: default (the sphinx default theme)
ThemeOption=option:value	Define theme options (this option can be repeated for multiple options). Multiple options can be separated by commas. The options available depend on the theme you are using, but for the default theme, the list of supported options can be found here.
TOCTitle=title	Use this title for the TOC. Default: Table of Contents
UploadTarget=target	For use with make upload, this is the rsync target Default: user@server:/www/website
UserStyle=text	Define a custom style (see Custom Styles for more information.)
UserText=key,text	Where ‘key’ appears in the theme template, use ‘text’ instead.
Version=version	Specify a version number (this is displayed by some themes, eg sphinx_rtd_theme)