Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
917d386
Initial plan
Copilot Jan 20, 2026
c1e90b9
Add comprehensive Sphinx documentation structure and content
Copilot Jan 20, 2026
73f6e83
Add .gitignore for docs build artifacts and docs README
Copilot Jan 20, 2026
4ab1e26
docs: Remove 'not for production' advice
r41k0u Jan 21, 2026
b039248
docs: remove c_int64 helper usage in return statement
r41k0u Jan 21, 2026
ab88177
docs: Fix features and video link in index.md
r41k0u Jan 21, 2026
b6d8b71
Remove unnecessary make.bat
r41k0u Jan 21, 2026
c1f32a2
docs: remove unnecessary fluff from README
r41k0u Jan 21, 2026
2d8c6c1
docs: Fix links and fluff in getting-started/index.md
r41k0u Jan 21, 2026
c58483a
Fix documentation: correct comm() usage, XDP types, copyright year, a…
Copilot Jan 21, 2026
4edfb18
docs: Remove unnecessary note from getting-started/installation
r41k0u Jan 22, 2026
f03c087
docs: Add more context for vmlinux in getting-started/installation
r41k0u Jan 22, 2026
e0251a0
docs: remove redundant c_int64 calls from quickstart
r41k0u Jan 22, 2026
92162e5
docs: Fix copyright year and authors in conf.py
r41k0u Jan 22, 2026
220adaf
docs: remove unnecessary c_int64 calls from quickstart guide
r41k0u Jan 22, 2026
c6aa107
docs: remove unnecessary quick navigation from index
r41k0u Jan 24, 2026
2e95b77
docs: Fix quickstart and add alternative compile option
r41k0u Jan 25, 2026
9ff3322
docs: fix type hints misconception in quickstart
r41k0u Jan 25, 2026
2840a5c
docs: fix common issues section of quickstart
r41k0u Jan 25, 2026
9131d04
docs: fix user-guide index
r41k0u Jan 26, 2026
06c81ae
docs: fix TC section in decorators
r41k0u Jan 26, 2026
217e760
docs: Fix decorators page in user-guide
r41k0u Jan 26, 2026
a31ef39
docs: Fix user-guide/maps.md
r41k0u Jan 27, 2026
8bfd998
docs: Fix user-guide/bpf-structs
r41k0u Jan 27, 2026
581269e
docs: Fix user-guide/compilation
r41k0u Jan 28, 2026
aded125
docs: Fix helpers and maps guide
r41k0u Jan 28, 2026
036830c
docs: Fix API reference
r41k0u Jan 28, 2026
3bff930
docs: Include cross-references to BCC-Examples
r41k0u Jan 29, 2026
4f56f8c
docs: Exclude README.md from toctree
r41k0u Jan 29, 2026
b6ecec9
docs: Format requirements
r41k0u Jan 29, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,7 @@ __pycache__/
vmlinux.py
~*
vmlinux.h

# Documentation build artifacts
docs/_build/
docs/_templates/
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
52 changes: 52 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# PythonBPF Documentation

This directory contains the Sphinx documentation for PythonBPF.

## Building the Documentation

### Prerequisites

Install the documentation dependencies:

**Using uv (recommended):**
```bash
uv pip install -r requirements.txt
# Or install the optional docs dependencies
uv pip install pythonbpf[docs]
```

**Using pip:**
```bash
pip install -r requirements.txt
# Or install the optional docs dependencies
pip install pythonbpf[docs]
```

### Build HTML Documentation

```bash
make html
```

The generated documentation will be in `_build/html/`. Open `_build/html/index.html` in a browser to view.

### Other Build Formats

```bash
make latexpdf # Build PDF documentation
make epub # Build ePub format
make clean # Clean build artifacts
```

## Documentation Structure

- `index.md` - Main landing page
- `getting-started/` - Installation and quick start guides
- `user-guide/` - Comprehensive user documentation
- `api/` - API reference documentation
- `conf.py` - Sphinx configuration
- `_static/` - Static files (images, CSS, etc.)

## Writing Documentation

Documentation is written in Markdown using [MyST-Parser](https://myst-parser.readthedocs.io/). See the existing files for examples.
Empty file added docs/_static/.gitkeep
Empty file.
Loading