diff --git a/docs/conf.py b/docs/conf.py index 679d441..7fc73b5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -7,27 +7,27 @@ import os import sys # Add the parent directory to the path so we can import pythonbpf -sys.path.insert(0, os.path.abspath('..')) +sys.path.insert(0, os.path.abspath("..")) # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = 'PythonBPF' -copyright = '2024-2026, r41k0u, varun-r-mallya' -author = 'r41k0u, varun-r-mallya' -release = '0.1.8' -version = '0.1.8' +project = "PythonBPF" +copyright = "2026, Pragyansh Chaturvedi, Varun Mallya" +author = "Pragyansh Chaturvedi, Varun Mallya" +release = "0.1.8" +version = "0.1.8" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration extensions = [ - 'myst_parser', - 'sphinx.ext.autodoc', - 'sphinx.ext.napoleon', - 'sphinx.ext.viewcode', - 'sphinx.ext.intersphinx', - 'sphinx_copybutton', + "myst_parser", + "sphinx.ext.autodoc", + "sphinx.ext.napoleon", + "sphinx.ext.viewcode", + "sphinx.ext.intersphinx", + "sphinx_copybutton", ] # MyST-Parser configuration @@ -53,51 +53,51 @@ napoleon_type_aliases = None # Intersphinx mapping intersphinx_mapping = { - 'python': ('https://docs.python.org/3', None), - 'llvmlite': ('https://llvmlite.readthedocs.io/en/latest/', None), + "python": ("https://docs.python.org/3", None), + "llvmlite": ("https://llvmlite.readthedocs.io/en/latest/", None), } -templates_path = ['_templates'] -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +templates_path = ["_templates"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # Source file suffixes source_suffix = { - '.rst': 'restructuredtext', - '.md': 'markdown', + ".rst": "restructuredtext", + ".md": "markdown", } # The master toctree document -master_doc = 'index' +master_doc = "index" # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = 'sphinx_rtd_theme' -html_static_path = ['_static'] +html_theme = "sphinx_rtd_theme" +html_static_path = ["_static"] # Theme options html_theme_options = { - 'logo_only': False, - 'display_version': True, - 'prev_next_buttons_location': 'bottom', - 'style_external_links': False, - 'vcs_pageview_mode': '', + "logo_only": False, + "display_version": True, + "prev_next_buttons_location": "bottom", + "style_external_links": False, + "vcs_pageview_mode": "", # Toc options - 'collapse_navigation': False, - 'sticky_navigation': True, - 'navigation_depth': 4, - 'includehidden': True, - 'titles_only': False + "collapse_navigation": False, + "sticky_navigation": True, + "navigation_depth": 4, + "includehidden": True, + "titles_only": False, } # -- Options for autodoc ----------------------------------------------------- autodoc_default_options = { - 'members': True, - 'member-order': 'bysource', - 'special-members': '__init__', - 'undoc-members': True, - 'exclude-members': '__weakref__' + "members": True, + "member-order": "bysource", + "special-members": "__init__", + "undoc-members": True, + "exclude-members": "__weakref__", } -autodoc_typehints = 'description' +autodoc_typehints = "description"