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.
The author of the document. This is put in the Dublin Core metadata. It defaults to the author option. 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 defaults to the author option.
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. 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. The default value is. Meta data for the guide element of content.
This is a sequence of tuples containing the type , the uri and the title of the optional guide information. If possible, default entries for the cover and toc types are automatically inserted.
However, the types can be explicitly overwritten if the default entries are not appropriate. Additional files that should be inserted before the text generated by Sphinx. It is a list of tuples containing the file name and the title. If the title is empty, no entry is added to toc. The default value is []. Additional files that should be inserted after the text generated by Sphinx. This option can be used to add an appendix. The depth of the table of contents in the file toc. It should be an integer greater than zero.
The default value is 3. Note: A deeply nested table of contents may be difficult to navigate. This flag determines if a toc entry is inserted again at the beginning of its nested toc listing. This allows easier navigation to the top of a chapter, but can be confusing because it mixes entries of different depth in one list.
The default value is True. This setting control the scope of the epub table of contents. The setting can have the following values:. This flag determines if sphinx should try to fix image formats that are not supported by some epub readers.
At the moment palette images with a small color table are upgraded. You need Pillow, the Python Image Library, installed to use this option. The default value is False because the automatic conversion may lose information. This option specifies the maximum width of images. If it is set to a value greater than zero, images with a width larger than the given value are scaled accordingly.
If it is zero, no scaling is performed. The default value is 0. You need the Python Image Library Pillow installed to use this option.
Control whether to display URL addresses. This is very useful for readers that have no other means to display the linked URL.
The settings can have the following values:. If true, add an index to the epub document. It specifies writing direction. It can accept 'horizontal' default and 'vertical'.
If your project uses Unicode characters, setting the engine to 'xelatex' or 'lualatex' and making sure to use an OpenType font with wide-enough glyph coverage is often easier than trying to make 'pdflatex' work with the extra Unicode characters. Since Sphinx 2. This value determines how to group the document tree into LaTeX source files. LaTeX document title. Can be empty to use the title of the startdoc document. This is inserted as LaTeX markup, so special characters like a backslash or ampersand must be represented by the proper LaTeX commands if they are to be inserted literally.
Author for the LaTeX document. The same LaTeX markup caveat as for title applies. LaTeX theme. Must be True or False.
If true, the startdoc document itself is not included in the output, only the documents referenced by it via TOC trees. This is not necessary anymore. Tuples with 5 items are still accepted. If given, this must be the name of an image file relative to the configuration directory that is the logo of the docs. It is placed at the top of the title page. This value determines the topmost sectioning unit. It should be chosen from 'part' , 'chapter' or 'section'.
The default is None ; the topmost sectioning unit is switched by documentclass: section is used if documentclass will be howto , otherwise chapter will be used. If true, add page references after internal references. This is very useful for printed copies of the manual. For backwards compatibility, True is still accepted. If True , the PDF build from the LaTeX files created by Sphinx will use xindy doc rather than makeindex for preparing the index of general terms from index usage.
This means that words with UTF-8 characters will get ordered correctly for the language. The default is True for 'xelatex' or 'lualatex' as makeindex , if any indexed term starts with a non-ascii character, creates. With 'lualatex' this then breaks the PDF build. The default is False for 'pdflatex' but True is recommended for non-English documents as soon as some indexed terms use non-ascii characters from the language script. Sphinx adds to xindy base distribution some dedicated support for using 'pdflatex' engine with Cyrillic scripts.
And whether with 'pdflatex' or Unicode engines, Cyrillic documents handle correctly the indexing of Latin names, even with diacritics. Its documentation has moved to LaTeX customization. A dictionary mapping 'howto' and 'manual' to names of real document classes that will be used as the base for the two Sphinx classes.
Default is to use 'article' for 'howto' and 'report' for 'manual'. 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. It is a collection of settings for LaTeX output ex. As a built-in LaTeX themes, manual and howto are bundled. A LaTeX theme for writing a manual. It imports the report document class Japanese documents use jsbook.
A LaTeX theme for writing an article. It imports the article document class Japanese documents use jreport rather. It defaults to 'manual'. A list of paths that contain custom LaTeX themes as subdirectories.
A string of 7 characters that should be used for underlining sections. The first character is used for first-level headings, the second for second-level headings and so on. A boolean that decides whether section numbers are included in text output.
Suffix for section numbers in text output. This value determines how to group the document tree into manual pages. Sphinx-pyreverse Simple sphinx wrapper around pyreverse from pylint suit to generate UML diagramms from modules. Also supports reflection for Flask, Bottle, and Tornado apps. Tut Tut is a tool that helps you write tutorial style documentation using Sphinx. Sphinx-Needs Sphinx-Needs allows the definition, linking, and filtering of need-objects: requirements, specifications, implementations, test cases, and more.
Markdown in. Markdown cells may contain toctree markup for generating tables of contents including. Sphinxcontrib-proof Sphinx extension to typeset definitions, theorems, proofs, etc.
Command Line Tools 5. Belle II Python Interface 6. List of Core Modules 7. Analysis 8. B2BII 9. Background module Calibration Event Generators Tools for Validation of the SoftwareTrigger So, we begin by creating a Sphinx documentation directory, docs. Then, we go to the docs directory and run sphinx-quickstart. Once we run sphinx-quickstart , it asks a few questions about this project.
Following are the example answers for these questions:. If we do make html here, Sphinx will generate the default documents which contains nothing about the Sample Project. The preview of the output can be viewed at:. Note : Sphinx is not a tool that offers fully automatic documents generation like Doxygen.
Therefore, we need to do some work to make the documents real. Although conf. The content of conf. Using Sphinx to generate a document is highly configurable. This section demonstrates the most basic configurations: the path to the project source code, theme for the documents, and adding extensions.
The Sample Project uses NumPy style for docstrings. Therefore, we need to add the extension napoleon for parsing NumPy style docstrings.
0コメント