github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/clients/python-wrapper/docs/conf.py (about)

     1  import os
     2  import sys
     3  
     4  sys.path.insert(0, os.path.abspath('../'))
     5  
     6  # Configuration file for the Sphinx documentation builder.
     7  #
     8  # For the full list of built-in configuration values, see the documentation:
     9  # https://www.sphinx-doc.org/en/master/usage/configuration.html
    10  
    11  # -- Project information -----------------------------------------------------
    12  # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
    13  
    14  project = 'python-lakefs'
    15  project_copyright = '2023, Treeverse'
    16  author = 'Treeverse'
    17  
    18  # -- General configuration ---------------------------------------------------
    19  # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
    20  
    21  extensions = [
    22      'sphinx.ext.autodoc',
    23      'sphinx.ext.viewcode',
    24      'sphinx.ext.todo',
    25      'sphinx_autodoc_typehints',
    26  ]
    27  
    28  exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
    29  
    30  language = 'en'
    31  
    32  # -- Options for HTML output -------------------------------------------------
    33  # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
    34  
    35  html_static_path = ['_static']
    36  html_css_files = ["custom.css"]
    37  html_theme = 'classic'
    38  html_theme_options = {
    39      "body_min_width": 1000,
    40      "body_max_width": "75%",
    41      "sidebarwidth": 300,
    42      "stickysidebar": "true"
    43  }
    44  
    45  # -- Options for todo extension ----------------------------------------------
    46  # https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration
    47  
    48  todo_include_todos = True