Add a new custom domain for vpr constraints file format

Author: kimiatkh

dev/pylint_check.py

@@ -60,6 +60,7 @@
     repo_path / "doc/_exts/rrgraphdomain/__init__.py",
     repo_path / "doc/_exts/sdcdomain/__init__.py",
     repo_path / "doc/_exts/archdomain/__init__.py",
+    repo_path / "doc/_exts/constraintsdomain/__init__.py",
     repo_path / "vpr/scripts/compare_timing_reports.py",
     repo_path / "vpr/scripts/profile/util.py",
     repo_path / "vpr/scripts/profile/parse_and_plot_detailed.py",

doc/_exts/constraintsdomain/__init__.py

@@ -0,0 +1,27 @@
+from sphinxcontrib.domaintools import custom_domain
+from sphinx.util.docfields import *
+
+
+def setup(app):
+    app.add_domain(
+        custom_domain(
+            "VPRConstraintsDomain",
+            name="vpr_constraints",
+            label="Place and Route Constraints",
+            elements=dict(
+                tag=dict(
+                    objname="Attribute",
+                    indextemplate="pair: %s; Tag Attribute",
+                    fields=[
+                        GroupedField(
+                            "required_parameter", label="Required Attributes", names=["req_param"]
+                        ),
+                        GroupedField(
+                            "optional_parameter", label="Optional Attributes", names=["opt_param"]
+                        ),
+                        Field("required", label="Tag Required", names=["required"]),
+                    ],
+                ),
+            ),
+        )
+    )

doc/src/conf.py

@@ -45,6 +45,7 @@
     "sphinx_markdown_tables",
     "sdcdomain",
     "archdomain",
+    "constraintsdomain",
     "rrgraphdomain",
     "myst_parser",
     "sphinx.ext.autodoc",