varun-r-mallya/python-bpf
1
0
Fork 0
mirror of https://github.com/varun-r-mallya/Python-BPF.git synced 2026-02-07 21:50:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix copyright year and authors in conf.py

Browse Source
This commit is contained in:
Pragyansh Chaturvedi
2026-01-23 03:21:29 +05:30
parent e0251a05bf
commit 92162e5cb4
1 changed files with 37 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
docs/conf.py
View File

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