pyroute2/docs at master · luis5tb/pyroute2 · GitHub

Name		Name	Last commit message	Last commit date
parent directory ..
_static		_static
_templates		_templates
Makefile		Makefile
README.md		README.md
aafigure.map		aafigure.map
arch.rst		arch.rst
conf.py		conf.py
debug.rst		debug.rst
event.rst		event.rst
index.rst		index.rst
ipdb.rst		ipdb.rst
ipdb_toc.rst		ipdb_toc.rst
iproute.rst		iproute.rst
ipset.rst		ipset.rst
mpls.rst		mpls.rst
ndb.rst		ndb.rst
ndb_addresses.rst		ndb_addresses.rst
ndb_auth.rst		ndb_auth.rst
ndb_debug.rst		ndb_debug.rst
ndb_init.rst		ndb_init.rst
ndb_interfaces.rst		ndb_interfaces.rst
ndb_objects.rst		ndb_objects.rst
ndb_reports.rst		ndb_reports.rst
ndb_routes.rst		ndb_routes.rst
ndb_schema.rst		ndb_schema.rst
ndb_sources.rst		ndb_sources.rst
ndb_toc.rst		ndb_toc.rst
ndb_transactions.rst		ndb_transactions.rst
ndb_views.rst		ndb_views.rst
netlink.rst		netlink.rst
netns.rst		netns.rst
nlsocket.rst		nlsocket.rst
parser.rst		parser.rst
pyroute2-cli.rst		pyroute2-cli.rst
pyroute2-dhcp-client.rst		pyroute2-dhcp-client.rst
remote.rst		remote.rst
usage.rst		usage.rst
wireguard.rst		wireguard.rst
wiset.rst		wiset.rst

README.md

Documentation

That's the project documentation source. In order to build html docs, one should install sphinx and run make docs in the project's root directory.

Actual built docs are available at http://docs.pyroute2.org/