Sign up using Facebook. Sign up using Email and Password. Post as a guest Name. Email Required, but never shown. The Overflow Blog. Podcast Making Agile work for data science. Stack Gives Back Featured on Meta. New post summary designs on greatest hits now, everywhere else eventually. Visit chat. If this config value is set to False , the JavaScript search function will only display the titles of matching documents, and no excerpt from the matching contents. The default is ''. This is the file name suffix for generated HTML files.
The default is ". Suffix for generated links to HTML files. Default is None use the builtin translator. Encoding of HTML output files. Default is 'utf-8'. Note that this encoding name must both be a valid Python encoding name and a valid HTML charset value.
This is standard docutils behavior. Suffix for section numbers. Default: ". Set to " " to suppress the final dot on section numbers. Language to be used for generating the HTML full-text search index. This defaults to the global language selected with language. If there is no support for this language, "en" is used which selects the English language. Each language except Japanese provides its own stemming algorithm. Sphinx uses a Python implementation by default.
You can use a C implementation to accelerate building the index file. A dictionary with options for the search language support, empty by default. The meaning of these options depends on the language selected. If not specified or None is specified, 'sphinx. DefaultSplitter' will be used. To keep compatibility, 'mecab' , 'janome' and 'default' are also acceptable.
However it will be deprecated in Sphinx The name of a JavaScript file relative to the configuration directory that implements a search results scorer. If empty, the default will be used.
Output file base name for HTML help builder. Default is 'pydoc'. These options influence the Apple Help output. The basename for the Apple Help Book. Defaults to the project name. The development region. The bundle version as a string. Defaults to '1'. The help bundle icon file, or None for no icon. The URL for your knowledgebase server, e.
Defaults to None for no remote search. The URL for remote content. Defaults to None for no remote content. This can be useful for jumping to a particular topic using the AHLookupAnchor function or the openHelpAnchor:inBook: method in your code. It also allows you to use help:anchor URLs; see the Apple documentation for more information on this topic.
Controls the minimum term length for the help indexer. Defaults to None , which means the default will be used. Either a language specification to use the built-in stopwords , or the path to a stopwords plist, or None if you do not want to use stopwords. Defaults to language , or if that is not set, to en. Specifies the locale to generate help for.
This is used to determine the name of the. Specifies the help book title. Specifies the identity to use for code signing, or None if code signing is not to be performed.
A list of additional arguments to pass to codesign when signing the help book. The path to the hiutil program. The path to the codesign program. If True , the builder will not run the indexer or the code signing tool, no matter what other settings are specified.
This is mainly useful for testing, or where you want to run the Sphinx build on a non-Mac OS X platform and then complete the final steps on OS X for some reason. These options influence the epub output.
The actual values for some of the options is not really important, they just have to be entered into the Dublin Core metadata. The basename for the epub file. It defaults to the project name. The HTML theme for the epub output. Since the default themes are not optimized for small screen space, using the same theme for HTML and epub output is usually not wise. This defaults to 'epub' , a theme designed to save visual space. The title of the document. The description of the document.
The default value is ''. The author of the document. This is put in the Dublin Core metadata. The default value is 'unknown'. The name of a person, organization, etc. The language of the document. The default is the language option or 'en' if unset. The publisher of the document. You may use any sensible string, e. The copyright of the document. It defaults to the copyright option but can be set independently for epub creation.
An identifier for the document. For published documents this is the ISBN number, but you can also use an alternative scheme, e. For published books the scheme is 'ISBN'. If you use the project homepage, 'URL' seems reasonable. A unique identifier for the document. You may use a random string. The cover page information. This is a tuple containing the filenames of the cover image and the html template. The rendered html cover page is inserted as the first item in the spine in content.
If the template filename is empty, no html cover page is created. No cover at all is created if the tuple is empty. 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 ". Suffix for generated links to HTML files. Encoding of HTML output files. Default is 'utf-8'. Note that this encoding name must both be a valid Python encoding name and a valid HTML charset value. This is standard docutils behavior. Suffix for section numbers. Default: ". Set to " " to suppress the final dot on section numbers.
Language to be used for generating the HTML full-text search index. This defaults to the global language selected with language. If there is no support for this language, "en" is used which selects the English language.
Each language except Japanese provides its own stemming algorithm. Sphinx uses a Python implementation by default.
You can use a C implementation to accelerate building the index file. PorterStemmer en. PyStemmer all languages. A dictionary with options for the search language support, empty by default. The meaning of these options depends on the language selected.
If not specified or None is specified, 'sphinx. DefaultSplitter' will be used. MeCab binding. Janome binding. To use this splitter, Janome is required. To keep compatibility, 'mecab' , 'janome' and 'default' are also acceptable. The name of a JavaScript file relative to the configuration directory that implements a search results scorer. If empty, the default will be used. Document authors can this feature manually with giving no-scaled-link class to the image:.
The default is 'mathjax'. Output is processed with HTML5 writer. Output is processed with HTML4 writer. Custom sidebar templates, must be a dictionary that maps document names to template names. All other keys are ignored. Output file base name for HTML help builder. Default is 'pydoc'. This is the file name suffix for generated HTML help files. These options influence the Apple Help output. The basename for the Apple Help Book. Defaults to the project name.
The development region. The bundle version as a string. Defaults to '1'. The help bundle icon file, or None for no icon. The URL for your knowledgebase server, e. Defaults to None for no remote search.
The URL for remote content. Defaults to None for no remote content. This can be useful for jumping to a particular topic using the AHLookupAnchor function or the openHelpAnchor:inBook: method in your code. It also allows you to use help:anchor URLs; see the Apple documentation for more information on this topic. Controls the minimum term length for the help indexer.
Defaults to None , which means the default will be used. Either a language specification to use the built-in stopwords , or the path to a stopwords plist, or None if you do not want to use stopwords.
Defaults to language , or if that is not set, to en. Specifies the locale to generate help for. This is used to determine the name of the. Specifies the help book title. Specifies the identity to use for code signing, or None if code signing is not to be performed. A list of additional arguments to pass to codesign when signing the help book. The path to the hiutil program. The path to the codesign program.
If True , the builder will not run the indexer or the code signing tool, no matter what other settings are specified. This is mainly useful for testing, or where you want to run the Sphinx build on a non-Mac OS X platform and then complete the final steps on OS X for some reason.
These options influence the epub output. The actual values for some of the options is not really important, they just have to be entered into the Dublin Core metadata. The basename for the epub file. It defaults to the project name.
The HTML theme for the epub output. Since the default themes are not optimized for small screen space, using the same theme for HTML and epub output is usually not wise. This defaults to 'epub' , a theme designed to save visual space.
The title of the document. It defaults to the project option. The description of the document. If true, the topmost sectioning unit is parts, else it is chapters. Default: False. A dictionary that contains LaTeX snippets that override those Sphinx usually puts into the generated.
Keep in mind that backslashes must be doubled in Python string literals to avoid interpretation as escape sequences. Paper size option of the document class 'a4paper' or 'letterpaper' , default 'letterpaper'.
Point size option of the document class '10pt' , '11pt' or '12pt' , default '10pt'. You can set this to '' to use the Computer Modern fonts. You can also set this to '' to disable fncychap. Override if you want to generate a differently-styled title page.
Override if you want to generate a different table of contents or put content between the title page and the TOC. Override if you want to generate the index differently or append some content after the index. A list of file names, relative to the configuration directory, to copy to the build directory when building LaTeX output. Image files that are referenced in source files e.
The output paper size 'letter' or 'a4'. Default is 'letter'. Default is '10pt'. Navigation index modules next previous Sphinx home Documentation ». Important points to note: If not otherwise documented, values must be strings, and their default is the empty string.
Builder" means the Builder class in the sphinx. Since conf. The contents of the config namespace are pickled so that Sphinx can find out when configuration changes , so it may not contain unpickleable values — delete them from the namespace with del if appropriate. There is a special object named tags available in the config file. It can be used to query and change the tags see Including content based on tags. Use tags. If you set today to a non-empty value, it is used.
Otherwise, the current time is formatted using time. Default is the stylesheet given by the selected theme. Warning If this config value is set to False , the JavaScript search function will only display the titles of matching documents, and no excerpt from the matching contents.
0コメント