github.com/filecoin-project/bacalhau@v0.3.23-0.20230228154132-45c989550ace/integration/airflow/docs/conf.py (about) 1 #!/usr/bin/env python 2 # 3 # {{ cookiecutter.project_slug }} documentation build configuration file, created by 4 # sphinx-quickstart on Fri Jun 9 13:47:02 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 import datetime 16 17 # If extensions (or modules to document with autodoc) are in another 18 # directory, add these directories to sys.path here. If the directory is 19 # relative to the documentation root, use os.path.abspath to make it 20 # absolute, like shown here. 21 # 22 import os 23 import sys 24 25 sys.path.insert(0, os.path.abspath("..")) 26 27 import bacalhau_airflow 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 ones. 37 extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"] 38 39 # Add any paths that contain templates here, relative to this directory. 40 templates_path = ["_templates"] 41 42 # The suffix(es) of source filenames. 43 # You can specify multiple suffix as a list of string: 44 # 45 # source_suffix = ['.rst', '.md'] 46 source_suffix = ".rst" 47 48 # The master toctree document. 49 master_doc = "index" 50 51 # General information about the project. 52 project = "Bacalhau Airflow Provider" 53 copyright = f"{ datetime.date.today().year }, The Bacalhau Project" 54 author = "Enrico Rotundo" 55 56 # The version info for the project you're documenting, acts as replacement 57 # for |version| and |release|, also used in various other places throughout 58 # the built documents. 59 # 60 # The short X.Y version. 61 ##version = bacalhau_airflow.__version__ 62 # The full version, including alpha/beta/rc tags. 63 ##release = bacalhau_airflow.__version__ 64 65 # The language for content autogenerated by Sphinx. Refer to documentation 66 # for a list of supported languages. 67 # 68 # This is also used if you do content translation via gettext catalogs. 69 # Usually you set "language" from the command line for these cases. 70 language = None 71 72 # List of patterns, relative to source directory, that match files and 73 # directories to ignore when looking for source files. 74 # This patterns also effect to html_static_path and html_extra_path 75 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] 76 77 # The name of the Pygments (syntax highlighting) style to use. 78 pygments_style = "sphinx" 79 80 # If true, `todo` and `todoList` produce output, else they produce nothing. 81 todo_include_todos = False 82 83 84 # -- Options for HTML output ------------------------------------------- 85 86 # The theme to use for HTML and HTML Help pages. See the documentation for 87 # a list of builtin themes. 88 # 89 html_theme = "alabaster" 90 91 # Theme options are theme-specific and customize the look and feel of a 92 # theme further. For a list of options available for each theme, see the 93 # documentation. 94 # 95 # html_theme_options = {} 96 97 # Add any paths that contain custom static files (such as style sheets) here, 98 # relative to this directory. They are copied after the builtin static files, 99 # so a file named "default.css" will overwrite the builtin "default.css". 100 html_static_path = ["_static"] 101 html_logo = "_static/bacalhau-horizontal.jpg" 102 103 # -- Options for HTMLHelp output --------------------------------------- 104 105 # Output file base name for HTML help builder. 106 htmlhelp_basename = "bacalhau_airflow_doc" 107 108 109 # -- Options for LaTeX output ------------------------------------------ 110 111 latex_elements = { 112 # The paper size ('letterpaper' or 'a4paper'). 113 # 114 # 'papersize': 'letterpaper', 115 # The font size ('10pt', '11pt' or '12pt'). 116 # 117 # 'pointsize': '10pt', 118 # Additional stuff for the LaTeX preamble. 119 # 120 # 'preamble': '', 121 # Latex figure (float) alignment 122 # 123 # 'figure_align': 'htbp', 124 } 125 126 # Grouping the document tree into LaTeX files. List of tuples 127 # (source start file, target name, title, author, documentclass 128 # [howto, manual, or own class]). 129 latex_documents = [ 130 ( 131 master_doc, 132 "bacalhau_airflow.tex", 133 "bacalhau_airflow Documentation", 134 "bacalhau_airflow", 135 "manual", 136 ), 137 ] 138 139 140 # -- Options for manual page output ------------------------------------ 141 142 # One entry per manual page. List of tuples 143 # (source start file, name, description, authors, manual section). 144 man_pages = [ 145 (master_doc, "bacalhau_airflow", "bacalhau_airflow Documentation", [author], 1) 146 ] 147 148 149 # -- Options for Texinfo output ---------------------------------------- 150 151 # Grouping the document tree into Texinfo files. List of tuples 152 # (source start file, target name, title, author, 153 # dir menu entry, description, category) 154 texinfo_documents = [ 155 ( 156 master_doc, 157 "bacalhau_airflow", 158 "bacalhau_airflow Documentation", 159 author, 160 "bacalhau_airflow", 161 "One line description of project.", 162 "Miscellaneous", 163 ), 164 ]