1
0
mirror of https://github.com/peeringdb/peeringdb.git synced 2024-05-11 05:55:09 +00:00

Docs 202109 (#1067)

* module docstrings

* db schema graph

* dev docs first pass

* dev docs pass 2

* add generated notification to top of generated docs files

* linting

* regen docs

Co-authored-by: Stefan Pratter <stefan@20c.com>
Co-authored-by: Sunshine Buchholz <sunshine@20c.com>
This commit is contained in:
Matt Griswold
2021-10-15 03:25:38 -05:00
committed by GitHub
parent 48a3a899f6
commit c21130eed9
133 changed files with 9962 additions and 986 deletions

View File

@@ -82,7 +82,7 @@ def validate_zipcode(zipcode, country):
def validate_prefix(prefix):
"""
validate ip prefix
Validate ip prefix.
Arguments:
- prefix: ipaddress.IPv4Network or an ipaddress.IPv6Network
@@ -104,7 +104,7 @@ def validate_prefix(prefix):
def validate_address_space(prefix):
"""
validate an ip prefix according to peeringdb specs
Validate an ip prefix according to peeringdb specs.
Arguments:
- prefix: ipaddress.IPv4Network or an ipaddress.IPv6Network
@@ -180,8 +180,8 @@ def validate_info_prefixes6(value):
def validate_prefix_overlap(prefix):
"""
validate that a prefix does not overlap with another prefix
on an already existing ixlan
Validate that a prefix does not overlap with another prefix
on an already existing ixlan.
Arguments:
- prefix: ipaddress.IPv4Network or an ipaddress.IPv6Network
@@ -208,7 +208,7 @@ def validate_prefix_overlap(prefix):
def validate_irr_as_set(value):
"""
Validates irr as-set string
Validate irr as-set string.
- the as-set/rs-set name has to conform to RFC 2622 (5.1 and 5.2)
- the source may be specified by AS-SET@SOURCE or SOURCE::AS-SET