gammu-1.42.0.tar.bz2: gammu-1.42.0/docs/manual/conf.py

"Fossies" - the Fresh Open Source Software Archive

Member "gammu-1.42.0/docs/manual/conf.py" (3 Oct 2020, 15522 Bytes) of package /linux/privat/gammu-1.42.0.tar.bz2:

As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) Python source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. For more information about "conf.py" see the Fossies "Dox" file reference documentation and the latest Fossies "Diffs" side-by-side code changes report:

1.41.0_vs_1.42.0.

1 # python-gammu documentation build configuration file, created by 2 # sphinx-quickstart on Tue Mar 10 18:14:17 2009. 3 # 4 # This file is execfile()d with the current directory set to its 5 # containing dir. 6 # 7 # Note that not all possible configuration values are present in this 8 # autogenerated file. 9 # 10 # All configuration values have a default; values that are commented out 11 # serve to show the default. 12 13 import sys 14 import os 15 import shlex 16 17 # Change what .. option:: parses 18 import sphinx.domains.std 19 import re 20 21 try: 22 import alabaster 23 has_alabaster = True 24 except ImportError: 25 has_alabaster = False 26 27 on_rtd = os.environ.get('READTHEDOCS', None) == 'True' 28 29 def gammu_process_link(self, env, refnode, has_explicit_title, title, target): 30 program = env.temp_data.get('std:program') 31 if not has_explicit_title: 32 if ' ' in title and not (title.startswith('/') or 33 title.startswith('-')): 34 program, target = re.split(' (?=-|--|/)?', title, 1) 35 program = sphinx.domains.std.ws_re.sub('-', program) 36 target = target.strip() 37 elif ' ' in target: 38 program, target = re.split(' (?=-|--|/)?', target, 1) 39 program = sphinx.domains.std.ws_re.sub('-', program) 40 refnode['refprogram'] = program 41 return title, target 42 43 sphinx.domains.std.option_desc_re = re.compile( 44 r'((?:/|-|--|^)[-_a-zA-Z0-9]+)(\s*.*?)(?=,\s+(?:/|-|--)|$)') 45 sphinx.domains.std.OptionXRefRole.process_link = gammu_process_link 46 47 # If extensions (or modules to document with autodoc) are in another directory, 48 # add these directories to sys.path here. If the directory is relative to the 49 # documentation root, use os.path.abspath to make it absolute, like shown here. 50 sys.path.append('@CMAKE_CURRENT_SOURCE_DIR@') 51 sys.path.append(os.path.abspath(os.path.dirname(__file__))) 52 53 # -- General configuration ------------------------------------------------ 54 55 # If your documentation needs a minimal Sphinx version, state it here. 56 #needs_sphinx = '1.0' 57 58 # Add any Sphinx extension module names here, as strings. They can be 59 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 60 # ones. 61 extensions = ['breathe', 'configext', 'sphinx.ext.graphviz', 'sphinx.ext.intersphinx'] 62 63 intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None)} 64 65 # Add any paths that contain templates here, relative to this directory. 66 templates_path = ['@CMAKE_CURRENT_SOURCE_DIR@/.templates'] 67 68 # The suffix(es) of source filenames. 69 # You can specify multiple suffix as a list of string: 70 # source_suffix = ['.rst', '.md'] 71 source_suffix = '.rst' 72 73 # The encoding of source files. 74 #source_encoding = 'utf-8-sig' 75 76 # The master toctree document. 77 master_doc = 'index' 78 79 # General information about the project. 80 project = 'Gammu' 81 copyright = '2009-2015, Michal Čihař <michal@cihar.com>' 82 author = 'Michal Čihař <michal@cihar.com>' 83 84 # The version info for the project you're documenting, acts as replacement for 85 # |version| and |release|, also used in various other places throughout the 86 # built documents. 87 # 88 # The short X.Y version. 89 version = '@GAMMU_VERSION@' 90 # The full version, including alpha/beta/rc tags. 91 release = version 92 93 # The language for content autogenerated by Sphinx. Refer to documentation 94 # for a list of supported languages. 95 # 96 # This is also used if you do content translation via gettext catalogs. 97 # Usually you set "language" from the command line for these cases. 98 language = None 99 100 # There are two options for replacing |today|: either, you set today to some 101 # non-false value, then it is used: 102 #today = '' 103 # Else, today_fmt is used as the format for a strftime call. 104 #today_fmt = '%B %d, %Y' 105 106 # List of patterns, relative to source directory, that match files and 107 # directories to ignore when looking for source files. 108 exclude_patterns = ['.build'] 109 110 # The reST default role (used for this markup: `text`) to use for all 111 # documents. 112 #default_role = None 113 114 # If true, '()' will be appended to :func: etc. cross-reference text. 115 #add_function_parentheses = True 116 117 # If true, the current module name will be prepended to all description 118 # unit titles (such as .. function::). 119 #add_module_names = True 120 121 # If true, sectionauthor and moduleauthor directives will be shown in the 122 # output. They are ignored by default. 123 #show_authors = False 124 125 # The name of the Pygments (syntax highlighting) style to use. 126 pygments_style = 'sphinx' 127 128 # A list of ignored prefixes for module index sorting. 129 #modindex_common_prefix = [] 130 131 # If true, keep warnings as "system message" paragraphs in the built documents. 132 #keep_warnings = False 133 134 # If true, `todo` and `todoList` produce output, else they produce nothing. 135 todo_include_todos = False 136 137 138 # -- Options for HTML output ---------------------------------------------- 139 140 # The theme to use for HTML and HTML Help pages. See the documentation for 141 # a list of builtin themes. 142 if on_rtd or not has_alabaster: 143 html_theme = 'default' 144 else: 145 html_theme = 'alabaster' 146 147 # Theme options are theme-specific and customize the look and feel of a theme 148 # further. For a list of options available for each theme, see the 149 # documentation. 150 #html_theme_options = {} 151 152 # Add any paths that contain custom themes here, relative to this directory. 153 html_theme_path = ['.'] 154 155 # The name for this set of Sphinx documents. If None, it defaults to 156 # "<project> v<release> documentation". 157 #html_title = None 158 159 # A shorter title for the navigation bar. Default is the same as html_title. 160 #html_short_title = None 161 162 # The name of an image file (relative to this directory) to place at the top 163 # of the sidebar. 164 #html_logo = None 165 166 # The name of an image file (within the static path) to use as favicon of the 167 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 168 # pixels large. 169 #html_favicon = None 170 171 # Add any paths that contain custom static files (such as style sheets) here, 172 # relative to this directory. They are copied after the builtin static files, 173 # so a file named "default.css" will overwrite the builtin "default.css". 174 html_static_path = [] 175 176 # Add any extra paths that contain custom files (such as robots.txt or 177 # .htaccess) here, relative to this directory. These files are copied 178 # directly to the root of the documentation. 179 #html_extra_path = [] 180 181 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 182 # using the given strftime format. 183 #html_last_updated_fmt = '%b %d, %Y' 184 185 # If true, SmartyPants will be used to convert quotes and dashes to 186 # typographically correct entities. 187 #html_use_smartypants = True 188 189 # Custom sidebar templates, maps document names to template names. 190 #html_sidebars = {} 191 192 # Additional templates that should be rendered to pages, maps page names to 193 # template names. 194 #html_additional_pages = {} 195 196 # If false, no module index is generated. 197 #html_domain_indices = True 198 199 # If false, no index is generated. 200 #html_use_index = True 201 202 # If true, the index is split into individual pages for each letter. 203 #html_split_index = False 204 205 # If true, links to the reST sources are added to the pages. 206 #html_show_sourcelink = True 207 208 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 209 #html_show_sphinx = True 210 211 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 212 #html_show_copyright = True 213 214 # If true, an OpenSearch description file will be output, and all pages will 215 # contain a <link> tag referring to it. The value of this option must be the 216 # base URL from which the finished HTML is served. 217 #html_use_opensearch = '' 218 219 # This is the file name suffix for HTML files (e.g. ".xhtml"). 220 #html_file_suffix = None 221 222 # Language to be used for generating the HTML full-text search index. 223 # Sphinx supports the following languages: 224 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' 225 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' 226 #html_search_language = 'en' 227 228 # A dictionary with options for the search language support, empty by default. 229 # Now only 'ja' uses this config value 230 #html_search_options = {'type': 'default'} 231 232 # The name of a javascript file (relative to the configuration directory) that 233 # implements a search results scorer. If empty, the default will be used. 234 #html_search_scorer = 'scorer.js' 235 236 # Output file base name for HTML help builder. 237 htmlhelp_basename = 'gammudoc' 238 239 # -- Options for LaTeX output --------------------------------------------- 240 241 latex_elements = { 242 # The paper size ('letterpaper' or 'a4paper'). 243 # 'papersize': 'a4', 244 245 # The font size ('10pt', '11pt' or '12pt'). 246 #'pointsize': '10pt', 247 248 # Additional stuff for the LaTeX preamble. 249 #'preamble': '', 250 251 # Latex figure (float) alignment 252 #'figure_align': 'htbp', 253 } 254 255 # Grouping the document tree into LaTeX files. List of tuples 256 # (source start file, target name, title, 257 # author, documentclass [howto, manual, or own class]). 258 latex_documents = [ 259 ('contents', 'gammu.tex', r'Gammu Manual', 260 r'Michal Čihař <michal@cihar.com>', 'manual', True), 261 ('smsd/index', 'smsd.tex', r'Gammu SMSD Daemon Manual', 262 r'Michal Čihař <michal@cihar.com>', 'manual', True), 263 ] 264 265 # The name of an image file (relative to this directory) to place at the top of 266 # the title page. 267 #latex_logo = None 268 269 # For "manual" documents, if this is true, then toplevel headings are parts, 270 # not chapters. 271 #latex_use_parts = False 272 273 # If true, show page references after internal links. 274 #latex_show_pagerefs = False 275 276 # If true, show URL addresses after external links. 277 #latex_show_urls = False 278 279 # Documents to append as an appendix to all manuals. 280 #latex_appendices = [] 281 282 # If false, no module index is generated. 283 latex_domain_indices = True 284 285 # -- Options for breathe extension ---------------------------------------- 286 287 breathe_projects = { 288 'api':'@DOXYGEN_OUTPUT@/xml', 289 } 290 291 breathe_default_project = 'api' 292 293 294 breathe_domain_by_extension = { 295 "h" : "c", 296 } 297 298 # -- Options for manual page output --------------------------------------- 299 300 # One entry per manual page. List of tuples 301 # (source start file, name, description, authors, manual section). 302 man_pages = [ 303 ('smsd/files', 'gammu-smsd-files', 'gammu-smsd(1) backend using filesystem as a message storage', 'Michal Čihař <michal@cihar.com>', 7), 304 ('smsd/tables', 'gammu-smsd-tables', 'description of tables for database backends of gammu-smsd(1)', 'Michal Čihař <michal@cihar.com>', 7), 305 ('smsd/mysql', 'gammu-smsd-mysql', 'gammu-smsd(1) backend using MySQL database server as a message storage', 'Michal Čihař <michal@cihar.com>', 7), 306 ('smsd/pgsql', 'gammu-smsd-pgsql', 'gammu-smsd(1) backend using PostgreSQL database server as a message storage', 'Michal Čihař <michal@cihar.com>', 7), 307 ('smsd/dbi', 'gammu-smsd-dbi', 'gammu-smsd(1) backend using DBI abstraction layer to use any supported database as a message storage', 'Michal Čihař <michal@cihar.com>', 7), 308 ('smsd/odbc', 'gammu-smsd-odbc', 'gammu-smsd(1) backend using ODBC abstraction layer to use any supported database as a message storage', 'Michal Čihař <michal@cihar.com>', 7), 309 ('smsd/sql', 'gammu-smsd-sql', 'gammu-smsd(1) backend using SQL abstraction layer to use any supported database as a message storage', 'Michal Čihař <michal@cihar.com>', 7), 310 ('smsd/run', 'gammu-smsd-run', 'documentation for RunOnReceive directive', 'Michal Čihař <michal@cihar.com>', 7), 311 ('smsd/null', 'gammu-smsd-null', 'gammu-smsd(1) backend not storing messages', 'Michal Čihař <michal@cihar.com>', 7), 312 ('smsd/config', 'gammu-smsdrc', 'gammu-smsd(1) configuration file', 'Michal Čihař <michal@cihar.com>', 5), 313 ('smsd/inject', 'gammu-smsd-inject', 'Inject messages into queue of SMS daemon for Gammu', 'Michal Čihař <michal@cihar.com>', 1), 314 ('smsd/monitor', 'gammu-smsd-monitor', 'Monitor state of SMS daemon for Gammu', 'Michal Čihař <michal@cihar.com>', 1), 315 ('smsd/smsd', 'gammu-smsd', 'SMS daemon for Gammu', 'Michal Čihař <michal@cihar.com>', 1), 316 ('config/index', 'gammurc', 'gammu(1) configuration file', 'Michal Čihař <michal@cihar.com>', 5), 317 ('gammu/index', 'gammu', 'Does some neat things with your cellular phone or modem.', 'Michal Čihař <michal@cihar.com>', 1), 318 ('formats/backup', 'gammu-backup', 'gammu(1) backup file format.', 'Michal Čihař <michal@cihar.com>', 5), 319 ('formats/smsbackup', 'gammu-smsbackup', 'gammu(1) SMS backup file format.', 'Michal Čihař <michal@cihar.com>', 5), 320 ('utils/jadmaker', 'jadmaker', 'JAD File Generator', 'Michal Čihař <michal@cihar.com>', 1), 321 ('utils/gammu-config', 'gammu-config', 'Gammu configurator', 'Michal Čihař <michal@cihar.com>', 1), 322 ('utils/gammu-detect', 'gammu-detect', 'Gammu device detection', 'Michal Čihař <michal@cihar.com>', 1), 323 ] 324 325 # If true, show URL addresses after external links. 326 #man_show_urls = False 327 328 329 # -- Options for Texinfo output ------------------------------------------- 330 331 # Grouping the document tree into Texinfo files. List of tuples 332 # (source start file, target name, title, author, 333 # dir menu entry, description, category) 334 texinfo_documents = [ 335 (master_doc, 'testproject', 'testproject Documentation', 336 author, 'testproject', 'One line description of project.', 337 'Miscellaneous'), 338 ] 339 340 # Documents to append as an appendix to all manuals. 341 #texinfo_appendices = [] 342 343 # If false, no module index is generated. 344 #texinfo_domain_indices = True 345 346 # How to display URL addresses: 'footnote', 'no', or 'inline'. 347 #texinfo_show_urls = 'footnote' 348 349 # If true, do not generate a @detailmenu in the "Top" node's menu. 350 #texinfo_no_detailmenu = False 351 352 353 # -- Options for Epub output ---------------------------------------------- 354 355 # Bibliographic Dublin Core info. 356 epub_title = project 357 epub_author = author 358 epub_publisher = author 359 epub_copyright = copyright 360 361 # The basename for the epub file. It defaults to the project name. 362 #epub_basename = project 363 364 # The HTML theme for the epub output. Since the default themes are not optimized 365 # for small screen space, using the same theme for HTML and epub output is 366 # usually not wise. This defaults to 'epub', a theme designed to save visual 367 # space. 368 #epub_theme = 'epub' 369 370 # The language of the text. It defaults to the language option 371 # or 'en' if the language is not set. 372 #epub_language = '' 373 374 # The scheme of the identifier. Typical schemes are ISBN or URL. 375 #epub_scheme = '' 376 377 # The unique identifier of the text. This can be a ISBN number 378 # or the project homepage. 379 #epub_identifier = '' 380 381 # A unique identification for the text. 382 #epub_uid = '' 383 384 # A tuple containing the cover image and cover page html template filenames. 385 #epub_cover = () 386 387 # A sequence of (type, uri, title) tuples for the guide element of content.opf. 388 #epub_guide = () 389 390 # HTML files that should be inserted before the pages created by sphinx. 391 # The format is a list of tuples containing the path and title. 392 #epub_pre_files = [] 393 394 # HTML files shat should be inserted after the pages created by sphinx. 395 # The format is a list of tuples containing the path and title. 396 #epub_post_files = [] 397 398 # A list of files that should not be packed into the epub file. 399 epub_exclude_files = ['search.html'] 400 401 # The depth of the table of contents in toc.ncx. 402 #epub_tocdepth = 3 403 404 # Allow duplicate toc entries. 405 #epub_tocdup = True 406 407 # Choose between 'default' and 'includehidden'. 408 #epub_tocscope = 'default' 409 410 # Fix unsupported image types using the Pillow. 411 #epub_fix_images = False 412 413 # Scale large images. 414 #epub_max_image_width = 0 415 416 # How to display URL addresses: 'footnote', 'no', or 'inline'. 417 #epub_show_urls = 'inline' 418 419 # If false, no index is generated. 420 #epub_use_index = True 421 422 graphviz_output_format = 'svg'