|
7 | 7 | import sys |
8 | 8 |
|
9 | 9 | # Add the parent directory to the path so we can import pythonbpf |
10 | | -sys.path.insert(0, os.path.abspath('..')) |
| 10 | +sys.path.insert(0, os.path.abspath("..")) |
11 | 11 |
|
12 | 12 | # -- Project information ----------------------------------------------------- |
13 | 13 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information |
14 | 14 |
|
15 | | -project = 'PythonBPF' |
16 | | -copyright = '2024-2026, r41k0u, varun-r-mallya' |
17 | | -author = 'r41k0u, varun-r-mallya' |
18 | | -release = '0.1.8' |
19 | | -version = '0.1.8' |
| 15 | +project = "PythonBPF" |
| 16 | +copyright = "2026, Pragyansh Chaturvedi, Varun Mallya" |
| 17 | +author = "Pragyansh Chaturvedi, Varun Mallya" |
| 18 | +release = "0.1.8" |
| 19 | +version = "0.1.8" |
20 | 20 |
|
21 | 21 | # -- General configuration --------------------------------------------------- |
22 | 22 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration |
23 | 23 |
|
24 | 24 | extensions = [ |
25 | | - 'myst_parser', |
26 | | - 'sphinx.ext.autodoc', |
27 | | - 'sphinx.ext.napoleon', |
28 | | - 'sphinx.ext.viewcode', |
29 | | - 'sphinx.ext.intersphinx', |
30 | | - 'sphinx_copybutton', |
| 25 | + "myst_parser", |
| 26 | + "sphinx.ext.autodoc", |
| 27 | + "sphinx.ext.napoleon", |
| 28 | + "sphinx.ext.viewcode", |
| 29 | + "sphinx.ext.intersphinx", |
| 30 | + "sphinx_copybutton", |
31 | 31 | ] |
32 | 32 |
|
33 | 33 | # MyST-Parser configuration |
|
53 | 53 |
|
54 | 54 | # Intersphinx mapping |
55 | 55 | intersphinx_mapping = { |
56 | | - 'python': ('https://docs.python.org/3', None), |
57 | | - 'llvmlite': ('https://llvmlite.readthedocs.io/en/latest/', None), |
| 56 | + "python": ("https://docs.python.org/3", None), |
| 57 | + "llvmlite": ("https://llvmlite.readthedocs.io/en/latest/", None), |
58 | 58 | } |
59 | 59 |
|
60 | | -templates_path = ['_templates'] |
61 | | -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 60 | +templates_path = ["_templates"] |
| 61 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
62 | 62 |
|
63 | 63 | # Source file suffixes |
64 | 64 | source_suffix = { |
65 | | - '.rst': 'restructuredtext', |
66 | | - '.md': 'markdown', |
| 65 | + ".rst": "restructuredtext", |
| 66 | + ".md": "markdown", |
67 | 67 | } |
68 | 68 |
|
69 | 69 | # The master toctree document |
70 | | -master_doc = 'index' |
| 70 | +master_doc = "index" |
71 | 71 |
|
72 | 72 | # -- Options for HTML output ------------------------------------------------- |
73 | 73 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output |
74 | 74 |
|
75 | | -html_theme = 'sphinx_rtd_theme' |
76 | | -html_static_path = ['_static'] |
| 75 | +html_theme = "sphinx_rtd_theme" |
| 76 | +html_static_path = ["_static"] |
77 | 77 |
|
78 | 78 | # Theme options |
79 | 79 | html_theme_options = { |
80 | | - 'logo_only': False, |
81 | | - 'display_version': True, |
82 | | - 'prev_next_buttons_location': 'bottom', |
83 | | - 'style_external_links': False, |
84 | | - 'vcs_pageview_mode': '', |
| 80 | + "logo_only": False, |
| 81 | + "display_version": True, |
| 82 | + "prev_next_buttons_location": "bottom", |
| 83 | + "style_external_links": False, |
| 84 | + "vcs_pageview_mode": "", |
85 | 85 | # Toc options |
86 | | - 'collapse_navigation': False, |
87 | | - 'sticky_navigation': True, |
88 | | - 'navigation_depth': 4, |
89 | | - 'includehidden': True, |
90 | | - 'titles_only': False |
| 86 | + "collapse_navigation": False, |
| 87 | + "sticky_navigation": True, |
| 88 | + "navigation_depth": 4, |
| 89 | + "includehidden": True, |
| 90 | + "titles_only": False, |
91 | 91 | } |
92 | 92 |
|
93 | 93 | # -- Options for autodoc ----------------------------------------------------- |
94 | 94 |
|
95 | 95 | autodoc_default_options = { |
96 | | - 'members': True, |
97 | | - 'member-order': 'bysource', |
98 | | - 'special-members': '__init__', |
99 | | - 'undoc-members': True, |
100 | | - 'exclude-members': '__weakref__' |
| 96 | + "members": True, |
| 97 | + "member-order": "bysource", |
| 98 | + "special-members": "__init__", |
| 99 | + "undoc-members": True, |
| 100 | + "exclude-members": "__weakref__", |
101 | 101 | } |
102 | 102 |
|
103 | | -autodoc_typehints = 'description' |
| 103 | +autodoc_typehints = "description" |
0 commit comments