doc: allow notes on Param API Reference pages

The notes that Param pages will contain after #6733 are added manually,
and because of it we need to add markers to differentiate between
automated and manual content, equal to what we do for class pages.

Signed-off-by: Antonio Torres <antorres@redhat.com>
Reviewed-By: Alexander Bokovoy <abokovoy@redhat.com>
Reviewed-By: Rob Crittenden <rcritten@redhat.com>
This commit is contained in:
Antonio Torres 2023-03-14 16:41:12 +01:00 committed by Florence Blanc-Renaud
parent ae014c6a3e
commit 3eed25e92f
67 changed files with 222 additions and 70 deletions

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _A6Record: .. _A6Record:
# A6Record # A6Record
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _AAAARecord: .. _AAAARecord:
# AAAARecord # AAAARecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _AFSDBRecord: .. _AFSDBRecord:
# AFSDBRecord # AFSDBRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _APLRecord: .. _APLRecord:
# APLRecord # APLRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _ARecord: .. _ARecord:
# ARecord # ARecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _AccessTime: .. _AccessTime:
# AccessTime # AccessTime
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Any: .. _Any:
# Any # Any
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _BinaryFile: .. _BinaryFile:
# BinaryFile # BinaryFile
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Bool: .. _Bool:
# Bool # Bool
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Bytes: .. _Bytes:
# Bytes # Bytes
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _BytesEnum: .. _BytesEnum:
# BytesEnum # BytesEnum
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _CERTRecord: .. _CERTRecord:
# CERTRecord # CERTRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _CNAMERecord: .. _CNAMERecord:
# CNAMERecord # CNAMERecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Certificate: .. _Certificate:
# Certificate # Certificate
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _CertificateSigningRequest: .. _CertificateSigningRequest:
# CertificateSigningRequest # CertificateSigningRequest
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _DHCIDRecord: .. _DHCIDRecord:
# DHCIDRecord # DHCIDRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _DLVRecord: .. _DLVRecord:
# DLVRecord # DLVRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _DNAMERecord: .. _DNAMERecord:
# DNAMERecord # DNAMERecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _DNOrURL: .. _DNOrURL:
# DNOrURL # DNOrURL
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _DNParam: .. _DNParam:
# DNParam # DNParam
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _DNSNameParam: .. _DNSNameParam:
# DNSNameParam # DNSNameParam
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _DNSRecord: .. _DNSRecord:
# DNSRecord # DNSRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _DSRecord: .. _DSRecord:
# DSRecord # DSRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Data: .. _Data:
# Data # Data
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _DateTime: .. _DateTime:
# DateTime # DateTime
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Decimal: .. _Decimal:
# Decimal # Decimal
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Dict: .. _Dict:
# Dict # Dict
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Enum: .. _Enum:
# Enum # Enum
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _File: .. _File:
# File # File
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Flag: .. _Flag:
# Flag # Flag
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _ForwardRecord: .. _ForwardRecord:
# ForwardRecord # ForwardRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _HINFORecord: .. _HINFORecord:
# HINFORecord # HINFORecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _HIPRecord: .. _HIPRecord:
# HIPRecord # HIPRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _HostPassword: .. _HostPassword:
# HostPassword # HostPassword
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _IA5Str: .. _IA5Str:
# IA5Str # IA5Str
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _IPSECKEYRecord: .. _IPSECKEYRecord:
# IPSECKEYRecord # IPSECKEYRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Int: .. _Int:
# Int # Int
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _IntEnum: .. _IntEnum:
# IntEnum # IntEnum
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _KEYRecord: .. _KEYRecord:
# KEYRecord # KEYRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _KXRecord: .. _KXRecord:
# KXRecord # KXRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _LOCRecord: .. _LOCRecord:
# LOCRecord # LOCRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _MDRecord: .. _MDRecord:
# MDRecord # MDRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _MINFORecord: .. _MINFORecord:
# MINFORecord # MINFORecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _MXRecord: .. _MXRecord:
# MXRecord # MXRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _NAPTRRecord: .. _NAPTRRecord:
# NAPTRRecord # NAPTRRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _NSECRecord: .. _NSECRecord:
# NSECRecord # NSECRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _NSRecord: .. _NSRecord:
# NSRecord # NSRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _NXTRecord: .. _NXTRecord:
# NXTRecord # NXTRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Number: .. _Number:
# Number # Number
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _OTPTokenKey: .. _OTPTokenKey:
# OTPTokenKey # OTPTokenKey
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _PTRRecord: .. _PTRRecord:
# PTRRecord # PTRRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Password: .. _Password:
# Password # Password
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Principal: .. _Principal:
# Principal # Principal
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _RPRecord: .. _RPRecord:
# RPRecord # RPRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _RRSIGRecord: .. _RRSIGRecord:
# RRSIGRecord # RRSIGRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _SIGRecord: .. _SIGRecord:
# SIGRecord # SIGRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _SPFRecord: .. _SPFRecord:
# SPFRecord # SPFRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _SRVRecord: .. _SRVRecord:
# SRVRecord # SRVRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _SSHFPRecord: .. _SSHFPRecord:
# SSHFPRecord # SSHFPRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _SerialNumber: .. _SerialNumber:
# SerialNumber # SerialNumber
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _Str: .. _Str:
# Str # Str
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _StrEnum: .. _StrEnum:
# StrEnum # StrEnum
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _TLSARecord: .. _TLSARecord:
# TLSARecord # TLSARecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _TXTRecord: .. _TXTRecord:
# TXTRecord # TXTRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _URIRecord: .. _URIRecord:
# URIRecord # URIRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -1,3 +1,5 @@
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
.. _UnsupportedDNSRecord: .. _UnsupportedDNSRecord:
# UnsupportedDNSRecord # UnsupportedDNSRecord
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)

View File

@ -277,10 +277,14 @@ def make_api_reference(validate_only=False):
will be created in Markdown format. 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} {reference}
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end) {automated_marker_end}
{notes} {notes}
""" """
@ -331,9 +335,21 @@ def make_api_reference(validate_only=False):
for param in ipa_classes: for param in ipa_classes:
lines = [ lines = [
automated_marker_start,
".. _%s:\n" % param.__name__, ".. _%s:\n" % param.__name__,
"# %s" % 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) api_contents["doc/api/%s.md" % param.__name__] = "\n".join(lines)
param_lines.append(" %s.md" % param.__name__) param_lines.append(" %s.md" % param.__name__)
@ -391,13 +407,17 @@ def make_api_reference(validate_only=False):
try: try:
with open("doc/api/%s.md" % cmd.name, "r") as f: 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() notes = f.read().split("//end)")[1].strip()
except FileNotFoundError: except FileNotFoundError:
notes = notes_template notes = notes_template
out = class_template.format( 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/%s.md" % cmd.name] = out
api_contents["doc/api/commands.rst"] = "\n".join(cmd_lines) api_contents["doc/api/commands.rst"] = "\n".join(cmd_lines)