github.com/rohankumardubey/proxyfs@v0.0.0-20210108201508-653efa9ab00e/docs/source/conf.py (about) 1 # -*- coding: utf-8 -*- 2 # 3 # ProxyFS documentation build configuration file, created by 4 # sphinx-quickstart on Mon Nov 20 11:16:31 2017. 5 # 6 # This file is execfile()d with the current directory set to its 7 # containing dir. 8 # 9 # Note that not all possible configuration values are present in this 10 # autogenerated file. 11 # 12 # All configuration values have a default; values that are commented out 13 # serve to show the default. 14 15 # If extensions (or modules to document with autodoc) are in another directory, 16 # add these directories to sys.path here. If the directory is relative to the 17 # documentation root, use os.path.abspath to make it absolute, like shown here. 18 # 19 import os 20 import sys 21 import datetime 22 import logging 23 import re 24 25 # sys.path.insert(0, os.path.abspath('.')) 26 27 28 # -- General configuration ------------------------------------------------ 29 30 # If your documentation needs a minimal Sphinx version, state it here. 31 # 32 # needs_sphinx = '1.0' 33 34 # Add any Sphinx extension module names here, as strings. They can be 35 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 36 # ones. 37 extensions = ['sphinx.ext.autodoc', 38 'sphinx.ext.ifconfig'] 39 40 41 # Add any paths that contain templates here, relative to this directory. 42 templates_path = ['_templates'] 43 44 # The suffix(es) of source filenames. 45 # You can specify multiple suffix as a list of string: 46 # 47 source_suffix = ['.rst'] 48 49 # The master toctree document. 50 master_doc = 'index' 51 52 # General information about the project. 53 project = u'ProxyFS' 54 copyright = u'2017, SwiftStack and the ProxyFS contributors' 55 author = u'SwiftStack and the ProxyFS contributors' 56 57 # The version info for the project you're documenting, acts as replacement for 58 # |version| and |release|, also used in various other places throughout the 59 # built documents. 60 # 61 # The full version, including alpha/beta/rc tags. 62 release = re.sub('^v', '', os.popen('git describe').read().strip()).rsplit('-', 1)[0] 63 # The short X.Y version. 64 version = release 65 66 # The language for content autogenerated by Sphinx. Refer to documentation 67 # for a list of supported languages. 68 # 69 # This is also used if you do content translation via gettext catalogs. 70 # Usually you set "language" from the command line for these cases. 71 language = None 72 73 # List of patterns, relative to source directory, that match files and 74 # directories to ignore when looking for source files. 75 # This patterns also effect to html_static_path and html_extra_path 76 exclude_patterns = [] 77 78 # The name of the Pygments (syntax highlighting) style to use. 79 pygments_style = 'sphinx' 80 81 # If true, `todo` and `todoList` produce output, else they produce nothing. 82 todo_include_todos = False 83 84 85 # -- Options for HTML output ---------------------------------------------- 86 87 # The theme to use for HTML and HTML Help pages. See the documentation for 88 # a list of builtin themes. 89 # 90 #html_theme = 'alabaster' 91 html_theme_path = ['theme'] 92 html_theme = 'swiftopensource' 93 94 # Theme options are theme-specific and customize the look and feel of a theme 95 # further. For a list of options available for each theme, see the 96 # documentation. 97 # 98 # html_theme_options = {} 99 100 # Add any paths that contain custom static files (such as style sheets) here, 101 # relative to this directory. They are copied after the builtin static files, 102 # so a file named "default.css" will overwrite the builtin "default.css". 103 html_static_path = ['_static'] 104 105 # Custom sidebar templates, must be a dictionary that maps document names 106 # to template names. 107 # 108 # This is required for the alabaster theme 109 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars 110 #html_sidebars = { 111 # '**': [ 112 # 'relations.html', # needs 'show_related': True theme option to display 113 # 'searchbox.html', 114 # ] 115 #} 116 117 118 # -- Options for HTMLHelp output ------------------------------------------ 119 120 # Output file base name for HTML help builder. 121 htmlhelp_basename = 'ProxyFSdoc' 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, 'ProxyFS.tex', u'ProxyFS Documentation', 149 u'SwiftStack and the ProxyFS contributors', '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, 'proxyfs', u'ProxyFS 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, 'ProxyFS', u'ProxyFS Documentation', 170 author, 'ProxyFS', 'One line description of project.', 171 'Miscellaneous'), 172 ] 173 174 175