github.com/bestbeforetoday/fabric-ca@v2.0.0-alpha+incompatible/docs/source/conf.py (about) 1 # -*- coding: utf-8 -*- 2 # 3 # Copyright IBM Corp. All Rights Reserved. 4 # 5 # SPDX-License-Identifier: Apache-2.0 6 # 7 # hyperledger-fabric-ca documentation build configuration file, created by 8 # sphinx-quickstart on Tue May 23 17:35:49 2017. 9 # 10 # This file is execfile()d with the current directory set to its 11 # containing dir. 12 # 13 # Note that not all possible configuration values are present in this 14 # autogenerated file. 15 # 16 # All configuration values have a default; values that are commented out 17 # serve to show the default. 18 19 # If extensions (or modules to document with autodoc) are in another directory, 20 # add these directories to sys.path here. If the directory is relative to the 21 # documentation root, use os.path.abspath to make it absolute, like shown here. 22 # 23 import os 24 import sys 25 sys.path.insert(0, os.path.abspath('.')) 26 27 import sphinx_rtd_theme 28 29 # -- General configuration ------------------------------------------------ 30 31 # If your documentation needs a minimal Sphinx version, state it here. 32 # 33 # needs_sphinx = '1.0' 34 35 # Add any Sphinx extension module names here, as strings. They can be 36 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 37 # ones. 38 39 extensions = ['sphinx.ext.autodoc', 40 'sphinx.ext.doctest', 41 'sphinx.ext.intersphinx', 42 'sphinx.ext.todo', 43 'sphinx.ext.imgmath', 44 'sphinx.ext.ifconfig', 45 'sphinx.ext.viewcode'] 46 47 # Add any paths that contain templates here, relative to this directory. 48 templates_path = ['_templates'] 49 50 # The suffix(es) of source filenames. 51 # You can specify multiple suffix as a list of string: 52 # 53 # source_suffix = ['.rst', '.md'] 54 source_suffix = '.rst' 55 56 # The master toctree document. 57 master_doc = 'index' 58 59 # General information about the project. 60 project = u'hyperledger-fabric-cadocs' 61 copyright = u'2017, hyperledger' 62 author = u'hyperledger' 63 64 # The version info for the project you're documenting, acts as replacement for 65 # |version| and |release|, also used in various other places throughout the 66 # built documents. 67 # 68 # The short X.Y version. 69 version = u'master' 70 # The full version, including alpha/beta/rc tags. 71 release = u'master' 72 73 # The language for content autogenerated by Sphinx. Refer to documentation 74 # for a list of supported languages. 75 # 76 # This is also used if you do content translation via gettext catalogs. 77 # Usually you set "language" from the command line for these cases. 78 language = None 79 80 # List of patterns, relative to source directory, that match files and 81 # directories to ignore when looking for source files. 82 # This patterns also effect to html_static_path and html_extra_path 83 exclude_patterns = [] 84 85 # The name of the Pygments (syntax highlighting) style to use. 86 pygments_style = 'sphinx' 87 88 # If true, `todo` and `todoList` produce output, else they produce nothing. 89 todo_include_todos = True 90 91 92 # -- Options for HTML output ---------------------------------------------- 93 94 # The theme to use for HTML and HTML Help pages. See the documentation for 95 # a list of builtin themes. 96 # 97 98 html_theme = 'sphinx_rtd_theme' 99 100 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] 101 102 html_add_permalinks = True 103 104 # Theme options are theme-specific and customize the look and feel of a theme 105 # further. For a list of options available for each theme, see the 106 # documentation. 107 # 108 # html_theme_options = {} 109 110 # Add any paths that contain custom static files (such as style sheets) here, 111 # relative to this directory. They are copied after the builtin static files, 112 # so a file named "default.css" will overwrite the builtin "default.css". 113 html_static_path = ['_static'] 114 115 def setup(app): 116 app.add_stylesheet('css/custom.css') 117 118 # -- Options for HTMLHelp output ------------------------------------------ 119 120 # Output file base name for HTML help builder. 121 htmlhelp_basename = 'hyperledger-fabric-cadocs' 122 123 124 # -- Options for LaTeX output --------------------------------------------- 125 126 latex_elements = { 127 # The paper size ('letterpaper' or 'a4paper'). 128 # 129 # 'papersize': 'letterpaper', 130 131 # The font size ('10pt', '11pt' or '12pt'). 132 # 133 # 'pointsize': '10pt', 134 135 # Additional stuff for the LaTeX preamble. 136 # 137 # 'preamble': '', 138 139 # Latex figure (float) alignment 140 # 141 # 'figure_align': 'htbp', 142 } 143 144 # Grouping the document tree into LaTeX files. List of tuples 145 # (source start file, target name, title, 146 # author, documentclass [howto, manual, or own class]). 147 latex_documents = [ 148 (master_doc, 'hyperledger-fabric-cadocs.tex', u'hyperledger-fabric-ca Documentation', 149 u'hyperledger', 'manual'), 150 ] 151 152 153 # -- Options for manual page output --------------------------------------- 154 155 # One entry per manual page. List of tuples 156 # (source start file, name, description, authors, manual section). 157 man_pages = [ 158 (master_doc, 'hyperledger-fabric-cadocs', u'hyperledger-fabric-ca Documentation', 159 [author], 1) 160 ] 161 162 163 # -- Options for Texinfo output ------------------------------------------- 164 165 # Grouping the document tree into Texinfo files. List of tuples 166 # (source start file, target name, title, author, 167 # dir menu entry, description, category) 168 texinfo_documents = [ 169 (master_doc, 'hyperledger-fabric-cadocs', u'hyperledger-fabric-ca Documentation', 170 author, 'hyperledger-fabric-ca', 'One line description of project.', 171 'Miscellaneous'), 172 ] 173 174 # Bibliographic Dublin Core info. 175 epub_title = project 176 epub_author = author 177 epub_publisher = author 178 epub_copyright = copyright 179 180 # A list of files that should not be packed into the epub file. 181 epub_exclude_files = ['search.html'] 182 183 # Example configuration for intersphinx: refer to the Python standard library. 184 intersphinx_mapping = {'https://docs.python.org/': None}