If extensions or modules to document with autodoc are in another directory,. If the directory is relative to the. If your documentation needs a minimal Sphinx version, state it here. Add any Sphinx extension module names here, as strings. They can be extensions. Add any paths that contain templates here, relative to this directory. The suffix of source filenames. The encoding of source files. The master toctree document. General information about the project. The version info for the project you're documenting, acts as replacement for.
The short X. Y version. The language for content autogenerated by Sphinx. Refer to documentation. There are two options for replacing today : either, you set today to some. List of patterns, relative to source directory, that match files and. If true, ' ' will be appended to :func: etc.
If true, the current module name will be prepended to all description. If true, sectionauthor and moduleauthor directives will be shown in the. They are ignored by default. The name of the Pygments syntax highlighting style to use. A list of ignored prefixes for module index sorting. See the documentation for.
Theme options are theme-specific and customize the look and feel of a theme. For a list of options available for each theme, see the. Add any paths that contain custom themes here, relative to this directory.
The name for this set of Sphinx documents. If None, it defaults to. A shorter title for the navigation bar. Can also be None to disable a default domain. The default is 'py'. Those objects in other domains whether the domain name is given explicitly, or selected by a default-domain directive will have the domain name explicitly prepended when named e.
The default role can always be set within individual documents using the standard reST default-role directive. Regardless of this setting, warnings are always written to the standard error stream when sphinx-build is run. The default is False , the pre Changed in version 3. If set to a major. Default is no requirement. This value can be a dictionary specifying version requirements for extensions in extensions , e. The version strings should be in the form major.
Requirements do not have to be specified for all extensions, only for those you want to check. This requires that the extension specifies its version to Sphinx see Developing extensions for Sphinx for how to do that. A URL to cross-reference manpage roles.
The patterns available are:. This also supports manpages specified as man. If true, Sphinx will warn about all references where the target cannot be found.
Default is False. You can activate this mode temporarily using the -n command-line switch. Note that type should include the domain name if present. For example, r'py:. If true, figures, tables and code-blocks are automatically numbered if they have a caption. The numref role is enabled. A dictionary mapping 'figure' , 'table' , 'code-block' and 'section' to strings that are used for format of figure numbers. Default is to use 'Fig. This naturally applies only if section numbering has been activated via the :numbered: option of the toctree directive.
If true, the Docutils Smart Quotes transform , originally based on SmartyPants limited to English and currently applying to many languages, will be used to convert quotes and dashes to typographically correct entities. Default: True. New in version 1. A docutils. But if it activates them, then smartquotes does prevail. This string customizes the Smart Quotes transform. See the file smartquotes. The default 'qDe' educates normal q uote characters " , ' , em- and en- D ashes , -- , and e llipses This is a dict whose default is:.
Each entry gives a sufficient condition to ignore the smartquotes setting and deactivate the Smart Quotes transform. Accepted keys are as above 'builders' or 'languages'. The values are lists. Currently, in case of invocation of make with multiple targets, the first target name is the only one which is tested against the 'builders' entry and it decides for all.
On the other hand the issue does not arise with direct usage of sphinx-build as it caches in its default usage the parsed source files in per builder locations. An alternative way to effectively deactivate or customize the smart quotes for a given builder, for example latex , is to use make this way:. This can follow some make html with no problem, in contrast to the situation from the prior note. It requires Docutils 0. A User-Agent of Sphinx.
It is used for a header on HTTP access ex. If true, Sphinx verifies server certifications. Default is True. A path to a certification file of CA or a path to directory which contains the certificates. This also allows a dictionary mapping hostname to the path to certificate file. The certificates are used to verify server certifications. Sphinx uses requests as a HTTP library internally.
These values determine how to format the current date, used as the replacement for today. If you set today to a non-empty value, it is used. Otherwise, the current time is formatted using time. The default language to highlight source code in. The default is 'default'. It is similar to 'python3' ; it is mostly a superset of 'python' but it fallbacks to 'none' without warning if failed.
The value should be a valid Pygments lexer name, see Showing code examples for more details. If you prefer Python 2 only highlighting, you can set it back to 'python'. A dictionary that maps language names to options for the lexer modules of Pygments. These are lexer-specific; for the options understood by each, see the Pygments documentation. A single dictionary of options are also allowed. The style name to use for Pygments highlighting of source code.
Changed in version 0. A boolean that decides whether parentheses are appended to function and method role text e. A boolean that decides whether codeauthor and sectionauthor directives produce any output in the built files.
A list of prefixes that are ignored for sorting the Python module index e. This can be handy if you document a project that consists of a single package. Works only for the HTML builder currently. Default is []. Trim spaces before footnote references that are necessary for the reST parser to recognize the footnote, but do not look too nice in the output. If true, doctest flags comments looking like doctest: FLAG, See the extension doctest for more possibilities of including doctests.
This was the behaviour before version 3. See the documentation on Internationalization for details. The code for the language the docs are written in. Any text automatically generated by Sphinx will be in that language. In the LaTeX builder, a suitable language will be selected as an option for the Babel package. Default is None , which means that no translation will be done. Directories in which to search for additional message catalogs see language , relative to the source directory.
The directories on this path are searched by the standard gettext module. Internal messages are fetched from a text domain of sphinx ; so if you add the directory. The default is ['locales']. It emits debug messages if message catalog directory not found.
The default is False. If true, Sphinx generates uuid information for version tracking in message catalogs.
It is used for:. Calculate similarity between new msgids and previously saved old msgids. This calculation takes a long time. If you want to accelerate the calculation, you can use python-levenshtein 3rd-party package written in C by using pip install python-levenshtein. To specify names to enable gettext extracting and translation applying for i18n additionally.
You can specify below names:. The filename format for language-specific figures. The available format tokens are:. Set this option to True if you want all displayed math to be numbered. A string used for formatting the labels of references to equations. Example: 'Eq. If True , displayed math equations are numbered across pages when numfig is enabled. The eq , not numref , role must be used to reference equation numbers.
See the section about theming. The default is 'alabaster'. A dictionary of options that influence the look and feel of the selected theme. These are theme-specific. For the options understood by the builtin themes, see this section. A list of paths that contain custom themes, either as subdirectories or as zip files. The style sheet to use for HTML pages.
Default is the stylesheet given by the selected theme. It is used to indicate the location of document using The Canonical Link Relation. Default: ''. Single values can also be put in this dictionary using the -A command-line option of sphinx-build.
If given, this must be the name of an image file path relative to the configuration directory that is the logo of the docs, or URL that points an image file for the logo.
It is placed at the top of the sidebar; its width should therefore not exceed pixels. Default: None. If given, this must be the name of an image file path relative to the configuration directory that is the favicon of the docs, or URL that points an image file for the favicon.
Modern browsers use this as the icon for tabs, windows and bookmarks. It should be a Windows-style icon file. A list of CSS files. The entry must be a filename string or a tuple containing the filename string and the attributes dictionary. It defaults to an empty list. As a special attribute, priority can be set as an integer to load the CSS file earlier or lazier step. For more information, refer Sphinx. A list of JavaScript filename. A list of paths that contain custom static files such as style sheets or script files.
If you would like to copy them intentionally, please add each filepath to this setting:. It allows to copy dotfiles under the directories. A list of paths that contain extra files not directly related to the documentation, such as robots. They are copied to the output directory. They will overwrite any existing file of the same name.
If true, quotes and dashes are converted to typographically correct entities. Set it to None or the empty string to disable permalinks. Previously, only boolean values were accepted. Deprecated since version 3. A text for permalinks for each heading and description environment. HTML tags are allowed. The keys can contain glob-style patterns 1 , in which case all matching documents will get the specified sidebars.
A warning is emitted when a more than one glob-style pattern matches for any document. If a value is a list, it specifies the complete list of sidebar templates to include. If all or some of the default sidebars are to be included, they must be put into this list as well.
Builtin themes are using these templates by default: ['localtoc. If a value is a single string, it specifies a custom sidebar to be added between the 'sourcelink. This is for compatibility with Sphinx versions before 1. This will render the custom template windowssidebar. Note that this value only has no effect if the chosen theme does not possess a sidebar, like the builtin scrolls and haiku themes.
Additional templates that should be rendered to HTML pages, must be a dictionary that maps document names to template names. This will render the template customdownload. If true, generate domain-specific indices in addition to the general index. For e. This value can be a bool or a list of index names that should be generated.
To find out the index name for a specific index, look at the HTML file name. For example, the Python module index has the name 'py-modindex'. If true, add an index to the HTML documents. If true, the index is generated twice: once as a single page with all the entries, and once as one page per starting letter. The default is True. Default is '. The default is ''. This is the file name suffix for generated HTML files. The default is ". Second job run full reindex every day at and restart sphinx daemon.
Was this page helpful? Your feedback about this content is important. Let us know what you think. Yes No. Additional feedback?
Submit Skip this.
0コメント