diff --git a/doc/api/A6Record.md b/doc/api/A6Record.md index e95c9fbcb..fdd908f19 100644 --- a/doc/api/A6Record.md +++ b/doc/api/A6Record.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _A6Record: -# A6Record \ No newline at end of file +# A6Record +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/AAAARecord.md b/doc/api/AAAARecord.md index 09a9ed546..4a23e2738 100644 --- a/doc/api/AAAARecord.md +++ b/doc/api/AAAARecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _AAAARecord: -# AAAARecord \ No newline at end of file +# AAAARecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/AFSDBRecord.md b/doc/api/AFSDBRecord.md index fde8ec158..0e57ed9c9 100644 --- a/doc/api/AFSDBRecord.md +++ b/doc/api/AFSDBRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _AFSDBRecord: -# AFSDBRecord \ No newline at end of file +# AFSDBRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/APLRecord.md b/doc/api/APLRecord.md index 5e545e7b1..0aec20915 100644 --- a/doc/api/APLRecord.md +++ b/doc/api/APLRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _APLRecord: -# APLRecord \ No newline at end of file +# APLRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/ARecord.md b/doc/api/ARecord.md index de130ac41..2745e6b67 100644 --- a/doc/api/ARecord.md +++ b/doc/api/ARecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _ARecord: -# ARecord \ No newline at end of file +# ARecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/AccessTime.md b/doc/api/AccessTime.md index 57c4739ad..ab0d5181a 100644 --- a/doc/api/AccessTime.md +++ b/doc/api/AccessTime.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _AccessTime: -# AccessTime \ No newline at end of file +# AccessTime +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/Any.md b/doc/api/Any.md index c93d392ad..3f3b76736 100644 --- a/doc/api/Any.md +++ b/doc/api/Any.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _Any: -# Any \ No newline at end of file +# Any +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/BinaryFile.md b/doc/api/BinaryFile.md index 8df897010..24d024968 100644 --- a/doc/api/BinaryFile.md +++ b/doc/api/BinaryFile.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _BinaryFile: -# BinaryFile \ No newline at end of file +# BinaryFile +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/Bool.md b/doc/api/Bool.md index 2fcdb1c58..b32073e43 100644 --- a/doc/api/Bool.md +++ b/doc/api/Bool.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _Bool: -# Bool \ No newline at end of file +# Bool +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/Bytes.md b/doc/api/Bytes.md index 7bd08a55c..dbb67ab74 100644 --- a/doc/api/Bytes.md +++ b/doc/api/Bytes.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _Bytes: -# Bytes \ No newline at end of file +# Bytes +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/BytesEnum.md b/doc/api/BytesEnum.md index fed9cb39c..9440fa9d2 100644 --- a/doc/api/BytesEnum.md +++ b/doc/api/BytesEnum.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _BytesEnum: -# BytesEnum \ No newline at end of file +# BytesEnum +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/CERTRecord.md b/doc/api/CERTRecord.md index 73dbbcd4b..32d5ca3d9 100644 --- a/doc/api/CERTRecord.md +++ b/doc/api/CERTRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _CERTRecord: -# CERTRecord \ No newline at end of file +# CERTRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/CNAMERecord.md b/doc/api/CNAMERecord.md index a4300de08..26c894a6f 100644 --- a/doc/api/CNAMERecord.md +++ b/doc/api/CNAMERecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _CNAMERecord: -# CNAMERecord \ No newline at end of file +# CNAMERecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/Certificate.md b/doc/api/Certificate.md index 825fbec33..7266b432f 100644 --- a/doc/api/Certificate.md +++ b/doc/api/Certificate.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _Certificate: -# Certificate \ No newline at end of file +# Certificate +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/CertificateSigningRequest.md b/doc/api/CertificateSigningRequest.md index 193c09f5f..4b33d2cab 100644 --- a/doc/api/CertificateSigningRequest.md +++ b/doc/api/CertificateSigningRequest.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _CertificateSigningRequest: -# CertificateSigningRequest \ No newline at end of file +# CertificateSigningRequest +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/DHCIDRecord.md b/doc/api/DHCIDRecord.md index 0bda2460f..ceaa97018 100644 --- a/doc/api/DHCIDRecord.md +++ b/doc/api/DHCIDRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _DHCIDRecord: -# DHCIDRecord \ No newline at end of file +# DHCIDRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/DLVRecord.md b/doc/api/DLVRecord.md index 7620c2aca..664a043e7 100644 --- a/doc/api/DLVRecord.md +++ b/doc/api/DLVRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _DLVRecord: -# DLVRecord \ No newline at end of file +# DLVRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/DNAMERecord.md b/doc/api/DNAMERecord.md index 9f40b11ae..6c96e8f07 100644 --- a/doc/api/DNAMERecord.md +++ b/doc/api/DNAMERecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _DNAMERecord: -# DNAMERecord \ No newline at end of file +# DNAMERecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/DNOrURL.md b/doc/api/DNOrURL.md index 9e65d06f5..348e7a095 100644 --- a/doc/api/DNOrURL.md +++ b/doc/api/DNOrURL.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _DNOrURL: -# DNOrURL \ No newline at end of file +# DNOrURL +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/DNParam.md b/doc/api/DNParam.md index 6da9c9aec..1ee8126e5 100644 --- a/doc/api/DNParam.md +++ b/doc/api/DNParam.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _DNParam: -# DNParam \ No newline at end of file +# DNParam +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/DNSNameParam.md b/doc/api/DNSNameParam.md index 0ec7988c7..89df4b93d 100644 --- a/doc/api/DNSNameParam.md +++ b/doc/api/DNSNameParam.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _DNSNameParam: -# DNSNameParam \ No newline at end of file +# DNSNameParam +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/DNSRecord.md b/doc/api/DNSRecord.md index 13cf1a912..ca6b489b7 100644 --- a/doc/api/DNSRecord.md +++ b/doc/api/DNSRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _DNSRecord: -# DNSRecord \ No newline at end of file +# DNSRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/DSRecord.md b/doc/api/DSRecord.md index 060aa7881..c46ab3a5c 100644 --- a/doc/api/DSRecord.md +++ b/doc/api/DSRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _DSRecord: -# DSRecord \ No newline at end of file +# DSRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/Data.md b/doc/api/Data.md index 68cbd7f69..01651b5d4 100644 --- a/doc/api/Data.md +++ b/doc/api/Data.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _Data: -# Data \ No newline at end of file +# Data +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/DateTime.md b/doc/api/DateTime.md index 97f315281..b553d4dd4 100644 --- a/doc/api/DateTime.md +++ b/doc/api/DateTime.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _DateTime: -# DateTime \ No newline at end of file +# DateTime +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/Decimal.md b/doc/api/Decimal.md index cd0f035f5..1f105b993 100644 --- a/doc/api/Decimal.md +++ b/doc/api/Decimal.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _Decimal: -# Decimal \ No newline at end of file +# Decimal +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/Dict.md b/doc/api/Dict.md index 7187604be..49b846025 100644 --- a/doc/api/Dict.md +++ b/doc/api/Dict.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _Dict: -# Dict \ No newline at end of file +# Dict +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/Enum.md b/doc/api/Enum.md index 6d6ffb089..6d1f98ced 100644 --- a/doc/api/Enum.md +++ b/doc/api/Enum.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _Enum: -# Enum \ No newline at end of file +# Enum +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/File.md b/doc/api/File.md index c00f3f673..9a986d921 100644 --- a/doc/api/File.md +++ b/doc/api/File.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _File: -# File \ No newline at end of file +# File +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/Flag.md b/doc/api/Flag.md index e64836809..18c6daeb7 100644 --- a/doc/api/Flag.md +++ b/doc/api/Flag.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _Flag: -# Flag \ No newline at end of file +# Flag +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/ForwardRecord.md b/doc/api/ForwardRecord.md index dd718b037..bce0733a8 100644 --- a/doc/api/ForwardRecord.md +++ b/doc/api/ForwardRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _ForwardRecord: -# ForwardRecord \ No newline at end of file +# ForwardRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/HINFORecord.md b/doc/api/HINFORecord.md index d3d518efe..461797243 100644 --- a/doc/api/HINFORecord.md +++ b/doc/api/HINFORecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _HINFORecord: -# HINFORecord \ No newline at end of file +# HINFORecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/HIPRecord.md b/doc/api/HIPRecord.md index 5eae940fe..2570b389e 100644 --- a/doc/api/HIPRecord.md +++ b/doc/api/HIPRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _HIPRecord: -# HIPRecord \ No newline at end of file +# HIPRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/HostPassword.md b/doc/api/HostPassword.md index 3427cfe9d..25f03e439 100644 --- a/doc/api/HostPassword.md +++ b/doc/api/HostPassword.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _HostPassword: -# HostPassword \ No newline at end of file +# HostPassword +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/IA5Str.md b/doc/api/IA5Str.md index a0b02e7ca..c9ab05ced 100644 --- a/doc/api/IA5Str.md +++ b/doc/api/IA5Str.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _IA5Str: -# IA5Str \ No newline at end of file +# IA5Str +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/IPSECKEYRecord.md b/doc/api/IPSECKEYRecord.md index 90361b6a8..9102ef7fb 100644 --- a/doc/api/IPSECKEYRecord.md +++ b/doc/api/IPSECKEYRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _IPSECKEYRecord: -# IPSECKEYRecord \ No newline at end of file +# IPSECKEYRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/Int.md b/doc/api/Int.md index def4c7317..4a21cb9b7 100644 --- a/doc/api/Int.md +++ b/doc/api/Int.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _Int: -# Int \ No newline at end of file +# Int +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/IntEnum.md b/doc/api/IntEnum.md index f4a41588d..96c6dac60 100644 --- a/doc/api/IntEnum.md +++ b/doc/api/IntEnum.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _IntEnum: -# IntEnum \ No newline at end of file +# IntEnum +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/KEYRecord.md b/doc/api/KEYRecord.md index 45a11c5a6..f849c818b 100644 --- a/doc/api/KEYRecord.md +++ b/doc/api/KEYRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _KEYRecord: -# KEYRecord \ No newline at end of file +# KEYRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/KXRecord.md b/doc/api/KXRecord.md index 637b9236b..da7dd2c84 100644 --- a/doc/api/KXRecord.md +++ b/doc/api/KXRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _KXRecord: -# KXRecord \ No newline at end of file +# KXRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/LOCRecord.md b/doc/api/LOCRecord.md index aa4622788..4f0e5b490 100644 --- a/doc/api/LOCRecord.md +++ b/doc/api/LOCRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _LOCRecord: -# LOCRecord \ No newline at end of file +# LOCRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/MDRecord.md b/doc/api/MDRecord.md index 62e3b64db..1cddf2267 100644 --- a/doc/api/MDRecord.md +++ b/doc/api/MDRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _MDRecord: -# MDRecord \ No newline at end of file +# MDRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/MINFORecord.md b/doc/api/MINFORecord.md index f36b1f28b..9a179d845 100644 --- a/doc/api/MINFORecord.md +++ b/doc/api/MINFORecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _MINFORecord: -# MINFORecord \ No newline at end of file +# MINFORecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/MXRecord.md b/doc/api/MXRecord.md index b582103f5..5f50aacf0 100644 --- a/doc/api/MXRecord.md +++ b/doc/api/MXRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _MXRecord: -# MXRecord \ No newline at end of file +# MXRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/NAPTRRecord.md b/doc/api/NAPTRRecord.md index f2e1bf488..73173af13 100644 --- a/doc/api/NAPTRRecord.md +++ b/doc/api/NAPTRRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _NAPTRRecord: -# NAPTRRecord \ No newline at end of file +# NAPTRRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/NSECRecord.md b/doc/api/NSECRecord.md index 654875eba..1363eed12 100644 --- a/doc/api/NSECRecord.md +++ b/doc/api/NSECRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _NSECRecord: -# NSECRecord \ No newline at end of file +# NSECRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/NSRecord.md b/doc/api/NSRecord.md index f9b485005..5989d068f 100644 --- a/doc/api/NSRecord.md +++ b/doc/api/NSRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _NSRecord: -# NSRecord \ No newline at end of file +# NSRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/NXTRecord.md b/doc/api/NXTRecord.md index fd6605d0f..46c93c3d0 100644 --- a/doc/api/NXTRecord.md +++ b/doc/api/NXTRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _NXTRecord: -# NXTRecord \ No newline at end of file +# NXTRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/Number.md b/doc/api/Number.md index 3b5ba999b..7e3743014 100644 --- a/doc/api/Number.md +++ b/doc/api/Number.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _Number: -# Number \ No newline at end of file +# Number +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/OTPTokenKey.md b/doc/api/OTPTokenKey.md index b1758f26d..183d03805 100644 --- a/doc/api/OTPTokenKey.md +++ b/doc/api/OTPTokenKey.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _OTPTokenKey: -# OTPTokenKey \ No newline at end of file +# OTPTokenKey +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/PTRRecord.md b/doc/api/PTRRecord.md index e45231502..1e9db72aa 100644 --- a/doc/api/PTRRecord.md +++ b/doc/api/PTRRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _PTRRecord: -# PTRRecord \ No newline at end of file +# PTRRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/Password.md b/doc/api/Password.md index 662adc474..a1cd70f16 100644 --- a/doc/api/Password.md +++ b/doc/api/Password.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _Password: -# Password \ No newline at end of file +# Password +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/Principal.md b/doc/api/Principal.md index 429b6f200..b6b1c0e40 100644 --- a/doc/api/Principal.md +++ b/doc/api/Principal.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _Principal: -# Principal \ No newline at end of file +# Principal +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/RPRecord.md b/doc/api/RPRecord.md index d3a512520..92fe914a2 100644 --- a/doc/api/RPRecord.md +++ b/doc/api/RPRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _RPRecord: -# RPRecord \ No newline at end of file +# RPRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/RRSIGRecord.md b/doc/api/RRSIGRecord.md index 961ed6912..8ba0b4229 100644 --- a/doc/api/RRSIGRecord.md +++ b/doc/api/RRSIGRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _RRSIGRecord: -# RRSIGRecord \ No newline at end of file +# RRSIGRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/SIGRecord.md b/doc/api/SIGRecord.md index b554c34be..ce5edd2b2 100644 --- a/doc/api/SIGRecord.md +++ b/doc/api/SIGRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _SIGRecord: -# SIGRecord \ No newline at end of file +# SIGRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/SPFRecord.md b/doc/api/SPFRecord.md index 5dc66501d..fc2b4980c 100644 --- a/doc/api/SPFRecord.md +++ b/doc/api/SPFRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _SPFRecord: -# SPFRecord \ No newline at end of file +# SPFRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/SRVRecord.md b/doc/api/SRVRecord.md index 9c969d50f..a4b7bddfe 100644 --- a/doc/api/SRVRecord.md +++ b/doc/api/SRVRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _SRVRecord: -# SRVRecord \ No newline at end of file +# SRVRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/SSHFPRecord.md b/doc/api/SSHFPRecord.md index 3705f063c..07db3b962 100644 --- a/doc/api/SSHFPRecord.md +++ b/doc/api/SSHFPRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _SSHFPRecord: -# SSHFPRecord \ No newline at end of file +# SSHFPRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/SerialNumber.md b/doc/api/SerialNumber.md index e7ee4a0bb..820b83534 100644 --- a/doc/api/SerialNumber.md +++ b/doc/api/SerialNumber.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _SerialNumber: -# SerialNumber \ No newline at end of file +# SerialNumber +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/Str.md b/doc/api/Str.md index 917f96d9f..6e586da7d 100644 --- a/doc/api/Str.md +++ b/doc/api/Str.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _Str: -# Str \ No newline at end of file +# Str +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/StrEnum.md b/doc/api/StrEnum.md index 7a2651485..ab7c9f409 100644 --- a/doc/api/StrEnum.md +++ b/doc/api/StrEnum.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _StrEnum: -# StrEnum \ No newline at end of file +# StrEnum +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/TLSARecord.md b/doc/api/TLSARecord.md index 6ac192875..8809543fa 100644 --- a/doc/api/TLSARecord.md +++ b/doc/api/TLSARecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _TLSARecord: -# TLSARecord \ No newline at end of file +# TLSARecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/TXTRecord.md b/doc/api/TXTRecord.md index bc577d862..3fa271ceb 100644 --- a/doc/api/TXTRecord.md +++ b/doc/api/TXTRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _TXTRecord: -# TXTRecord \ No newline at end of file +# TXTRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/URIRecord.md b/doc/api/URIRecord.md index c8a9372b8..7c0c63327 100644 --- a/doc/api/URIRecord.md +++ b/doc/api/URIRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _URIRecord: -# URIRecord \ No newline at end of file +# URIRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/doc/api/UnsupportedDNSRecord.md b/doc/api/UnsupportedDNSRecord.md index 6b45cec62..7f0f7780a 100644 --- a/doc/api/UnsupportedDNSRecord.md +++ b/doc/api/UnsupportedDNSRecord.md @@ -1,3 +1,5 @@ +[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) .. _UnsupportedDNSRecord: -# UnsupportedDNSRecord \ No newline at end of file +# UnsupportedDNSRecord +[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) diff --git a/makeapi.in b/makeapi.in index a2e8688ed..a801b9253 100644 --- a/makeapi.in +++ b/makeapi.in @@ -277,10 +277,14 @@ def make_api_reference(validate_only=False): will be created in Markdown format. """ - class_template = """[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.) + # Markers to separate automated content from manual notes + automated_marker_start = "[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)" # noqa: E501 + automated_marker_end = "[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)" # noqa: E501 + + class_template = """{automated_marker_start} {reference} -[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) +{automated_marker_end} {notes} """ @@ -331,9 +335,21 @@ def make_api_reference(validate_only=False): for param in ipa_classes: lines = [ + automated_marker_start, ".. _%s:\n" % param.__name__, "# %s" % param.__name__, + automated_marker_end ] + + try: + with open("doc/api/%s.md" % param.__name__, "r") as f: + # Read notes written to page + notes = f.read().split("//end)")[1].strip() + except FileNotFoundError: + notes = "" + + lines.append(notes) + api_contents["doc/api/%s.md" % param.__name__] = "\n".join(lines) param_lines.append(" %s.md" % param.__name__) @@ -391,13 +407,17 @@ def make_api_reference(validate_only=False): try: with open("doc/api/%s.md" % cmd.name, "r") as f: - # Read notes write to template + # Read notes written to template notes = f.read().split("//end)")[1].strip() except FileNotFoundError: notes = notes_template out = class_template.format( - reference="\n".join(lines), notes=notes).strip() + automated_marker_start=automated_marker_start, + reference="\n".join(lines), + notes=notes, + automated_marker_end=automated_marker_end + ).strip() api_contents["doc/api/%s.md" % cmd.name] = out api_contents["doc/api/commands.rst"] = "\n".join(cmd_lines)