use jinja only to do macro includes, fixes bug with links in included files

nmwsharp · nmwsharp · commit 2d6410be2ff7 · 2025-06-23T10:40:32.000-07:00
diff --git a/cpp/mkdocs.yml b/cpp/mkdocs.yml
@@ -12,8 +12,6 @@ markdown_extensions:
   - pymdownx.emoji
   - pymdownx.tabbed:
         alternate_style: true 
-  - markdown_include.include:
-        base_path: source
 
 extra:
   search:
diff --git a/cpp/source/structures/curve_network/color_quantities.md b/cpp/source/structures/curve_network/color_quantities.md
@@ -31,4 +31,4 @@ polyscope::getCurveNetwork(curveNetworkName)->addEdgeColorQuantity("random color
 
     RGB values are interpreted in the range `[0,1]`.
 
-{!common/color_quantity.md!}
+[[% include 'common/color_quantity.md' %]]
diff --git a/cpp/source/structures/curve_network/scalar_quantities.md b/cpp/source/structures/curve_network/scalar_quantities.md
@@ -30,4 +30,4 @@ polyscope::getCurveNetwork(curveNetworkName)->addNodeScalarQuantity("sample valu
     - `values` is the array of scalars at edges . The type should be [adaptable]([[url.prefix]]/data_adaptors) to a `float` scalar array. The length should be the number of edges in the curve network.
 
 
-{!common/scalar_quantity.md!}
+[[% include 'common/scalar_quantity.md' %]]
diff --git a/cpp/source/structures/curve_network/vector_quantities.md b/cpp/source/structures/curve_network/vector_quantities.md
@@ -37,4 +37,4 @@ polyscope::show();
     Note: the inner vector type of the input _must_ be 3D dimensional, or you risk compiler errors, segfaults, or worse. If you want to add 2D vectors (usually to a 2D curve network), `addEdgeVectorQuantity2D` exists with the same signature. See [2D data]([[url.prefix]]/features/2D_data).
 
 
-{!common/vector_quantity.md!}
+[[% include 'common/vector_quantity.md' %]]
diff --git a/cpp/source/structures/floating_quantities/images.md b/cpp/source/structures/floating_quantities/images.md
@@ -104,7 +104,7 @@ These can be called at the root level, like `polyscope::addScalarImageQuantity()
     - `imageOrigin` is the row origin convention, see above
     - `type` is the scalar datatype as for other scalar quantities
 
-{!common/scalar_quantity.md!}
+[[% include 'common/scalar_quantity.md' %]]
 
 ---
 ## Color Image Quantity
@@ -133,7 +133,7 @@ These can be called at the root level, like `polyscope::addColorImageQuantity()`
 
 By default, alpha values are interpreted to be non-premultiplied. Use  `colorAlphaImage->setIsPremultiplied(true);` to directly pass premultiplied alpha images.
 
-{!common/color_quantity.md!}
+[[% include 'common/color_quantity.md' %]]
 
 
 ---
diff --git a/cpp/source/structures/floating_quantities/render_images.md b/cpp/source/structures/floating_quantities/render_images.md
@@ -109,7 +109,7 @@ This can be called at the root level, like `polyscope::addColorRenderImageQuanti
     
     RGB values are interpreted in the range `[0,1]`.
 
-{!common/color_quantity.md!}
+[[% include 'common/color_quantity.md' %]]
 
 ---
 ## Scalar Render Image Quantity
@@ -147,7 +147,7 @@ This can be called at the root level, like `polyscope::addScalarRenderImageQuant
 
     Depth values should be radial ray distance from the camera origin, _not_ perpendicular distance from the image plane.
 
-{!common/scalar_quantity.md!}
+[[% include 'common/scalar_quantity.md' %]]
 
 ---
 ## Raw Color Render Image Quantity
diff --git a/cpp/source/structures/point_cloud/color_quantities.md b/cpp/source/structures/point_cloud/color_quantities.md
@@ -22,4 +22,4 @@ polyscope::getPointCloud(pointCloudName)->addColorQuantity("random color", randC
     RGB values are interpreted in the range `[0,1]`.
 
 
-{!common/color_quantity.md!}
+[[% include 'common/color_quantity.md' %]]
diff --git a/cpp/source/structures/point_cloud/parameterization_quantities.md b/cpp/source/structures/point_cloud/parameterization_quantities.md
@@ -25,4 +25,4 @@ Typically parameterizations are used on meshes (which is also supported in Polys
     - `type` the default interpretation of the coordinate scale, see below
 
 
-{!common/parameterization_quantity.md!}
+[[% include 'common/parameterization_quantity.md' %]]
diff --git a/cpp/source/structures/point_cloud/scalar_quantities.md b/cpp/source/structures/point_cloud/scalar_quantities.md
@@ -20,4 +20,4 @@ polyscope::getPointCloud(pointCloudName)->addScalarQuantity("xC", xC);
     - `values` is the array of scalars at points. The type should be [adaptable]([[url.prefix]]/data_adaptors) to a `float` scalar array. The length should be the number of points in the point cloud.
 
 
-{!common/scalar_quantity.md!}
+[[% include 'common/scalar_quantity.md' %]]
diff --git a/cpp/source/structures/point_cloud/vector_quantities.md b/cpp/source/structures/point_cloud/vector_quantities.md
@@ -9,4 +9,4 @@ Visualize vector-valued data at the points of a point cloud.
 
     Note: the inner vector type of the input _must_ be 3D dimensional, or you risk compiler errors, segfaults, or worse. If you want to add 2D vectors (usually to a 2D point cloud), `addVectorQuantity2D` exists with the same signature. See [2D data]([[url.prefix]]/features/2D_data).
 
-{!common/vector_quantity.md!}
+[[% include 'common/vector_quantity.md' %]]
diff --git a/cpp/source/structures/surface_mesh/color_quantities.md b/cpp/source/structures/surface_mesh/color_quantities.md
@@ -87,4 +87,4 @@ The `FilterMode` can be set to adjust how values are sampled from the texture. `
     - `FilterMode::Nearest` for sharp nearest-neighbor sampling
 
 
-{!common/color_quantity.md!}
+[[% include 'common/color_quantity.md' %]]
diff --git a/cpp/source/structures/surface_mesh/parameterization_quantities.md b/cpp/source/structures/surface_mesh/parameterization_quantities.md
@@ -89,4 +89,4 @@ Additionally, the seams of a parameterization can be visualized as a [curve netw
     - `structureName` the name of the new curve network structure. If left as the empty string (default) a name will be generated.
 
 
-{!common/parameterization_quantity.md!}
+[[% include 'common/parameterization_quantity.md' %]]
diff --git a/cpp/source/structures/surface_mesh/scalar_quantities.md b/cpp/source/structures/surface_mesh/scalar_quantities.md
@@ -123,4 +123,4 @@ The `FilterMode` can be set to adjust how values are sampled from the texture. `
     - `FilterMode::Nearest` for sharp nearest-neighbor sampling
 
 
-{!common/scalar_quantity.md!}
+[[% include 'common/scalar_quantity.md' %]]
diff --git a/cpp/source/structures/surface_mesh/vector_quantities.md b/cpp/source/structures/surface_mesh/vector_quantities.md
@@ -102,4 +102,4 @@ _One forms_ are tangent vector-like quantities represented as integrated scalars
 
     Remember, before passing edge-valued data, be sure your [indexing convention](../indexing_convention) matches what Polyscope expects.
 
-{!common/vector_quantity.md!}
+[[% include 'common/vector_quantity.md' %]]
diff --git a/cpp/source/structures/volume_grid/scalar_quantities.md b/cpp/source/structures/volume_grid/scalar_quantities.md
@@ -86,7 +86,7 @@ polyscope::show();
     
     - `func` is a function which performs a batch of evaluations of the implicit function. It should have a signature like `void(float* in_pos_ptr, float* out_val_ptr, size_t N)`. The first arg is a length-3N array of positions for queries, and the second is an (already-allocated) length-N output array of floats to write the result to. The last arg is the numbrer of queries `N`.
 
-{!common/scalar_quantity.md!}
+[[% include 'common/scalar_quantity.md' %]]
 
 ### Visualizing Isosurfaces
 
diff --git a/cpp/source/structures/volume_mesh/color_quantities.md b/cpp/source/structures/volume_mesh/color_quantities.md
@@ -41,4 +41,4 @@ polyscope::show();
     RGB values are interpreted in the range `[0,1]`.
 
 
-{!common/color_quantity.md!}
+[[% include 'common/color_quantity.md' %]]
diff --git a/cpp/source/structures/volume_mesh/scalar_quantities.md b/cpp/source/structures/volume_mesh/scalar_quantities.md
@@ -50,4 +50,4 @@ polyscope::show();
 Slice planes have [special functionality]([[url.prefix]]/features/slice_planes/#inspecting-volume-meshes) for volume mesh vertex values---they can _inspect_ quantities on volume meshes and render them on the interior of the volume. See the slice plane documentation for details.
 
 
-{!common/scalar_quantity.md!}
+[[% include 'common/scalar_quantity.md' %]]
diff --git a/cpp/source/structures/volume_mesh/vector_quantities.md b/cpp/source/structures/volume_mesh/vector_quantities.md
@@ -49,4 +49,4 @@ polyscope::show();
     Note: the inner vector type of the input _must_ be 3D dimensional, or you risk compiler errors, segfaults, or worse.
 
 
-{!common/vector_quantity.md!}
+[[% include 'common/vector_quantity.md' %]]
diff --git a/py/mkdocs.yml b/py/mkdocs.yml
@@ -12,8 +12,6 @@ markdown_extensions:
   - pymdownx.emoji
   - pymdownx.tabbed:
         alternate_style: true 
-  - markdown_include.include:
-        base_path: source
     
 
 extra:
diff --git a/py/source/structures/curve_network/color_quantities.md b/py/source/structures/curve_network/color_quantities.md
@@ -38,4 +38,4 @@ ps.show()
     
     This function also accepts optional keyword arguments listed below, which customize the appearance and behavior of the quantity.
     
-{!common/color_quantity.md!}
+[[% include 'common/color_quantity.md' %]]
diff --git a/py/source/structures/curve_network/scalar_quantities.md b/py/source/structures/curve_network/scalar_quantities.md
@@ -42,4 +42,4 @@ ps.show()
     
     This function also accepts optional keyword arguments listed below, which customize the appearance and behavior of the quantity.
     
-{!common/scalar_quantity.md!}
+[[% include 'common/scalar_quantity.md' %]]
diff --git a/py/source/structures/curve_network/vector_quantities.md b/py/source/structures/curve_network/vector_quantities.md
@@ -42,4 +42,4 @@ ps.show()
     This function also accepts optional keyword arguments listed below, which customize the appearance and behavior of the quantity.
    
 
-{!common/vector_quantity.md!}
+[[% include 'common/vector_quantity.md' %]]
diff --git a/py/source/structures/floating_quantities/images.md b/py/source/structures/floating_quantities/images.md
@@ -81,7 +81,7 @@ These can be called at the root level, like `ps.add_scalar_image_quantity()`, or
     
     This function also accepts optional keyword arguments listed below, which customize the appearance and behavior of the quantity.
 
-{!common/scalar_quantity.md!}
+[[% include 'common/scalar_quantity.md' %]]
 
 ---
 ## Color Image Quantity
@@ -109,7 +109,7 @@ These can be called at the root level, like `ps.add_color_image_quantity()`, or
 
 By default, alpha values are interpreted to be non-premultiplied. Use the keyword argument `is_premultiplied=True` to directly pass premultiplied alpha images.
 
-{!common/color_quantity.md!}
+[[% include 'common/color_quantity.md' %]]
 
 
 ---
diff --git a/py/source/structures/floating_quantities/render_images.md b/py/source/structures/floating_quantities/render_images.md
@@ -102,7 +102,7 @@ If normals are not given, they will be computed internally via screen-space deri
     
     This function also accepts optional keyword arguments listed below, which customize the appearance and behavior of the quantity.
 
-{!common/color_quantity.md!}
+[[% include 'common/color_quantity.md' %]]
 
 ---
 ## Scalar Render Image Quantity
@@ -141,7 +141,7 @@ If normals are not given, they will be computed internally via screen-space deri
 
     This function also accepts optional keyword arguments listed below, which customize the appearance and behavior of the quantity.
 
-{!common/scalar_quantity.md!}
+[[% include 'common/scalar_quantity.md' %]]
 
 ---
 ## Raw Color Render Image Quantity
diff --git a/py/source/structures/point_cloud/color_quantities.md b/py/source/structures/point_cloud/color_quantities.md
@@ -30,4 +30,4 @@ ps.show()
     This function also accepts optional keyword arguments listed below, which customize the appearance and behavior of the quantity.
 
     
-{!common/color_quantity.md!}
+[[% include 'common/color_quantity.md' %]]
diff --git a/py/source/structures/point_cloud/parameterization_quantities.md b/py/source/structures/point_cloud/parameterization_quantities.md
@@ -17,5 +17,5 @@ Typically parameterizations are used on meshes (which is also supported in Polys
     
 
 
-{!common/parameterization_quantity.md!}
+[[% include 'common/parameterization_quantity.md' %]]
 
diff --git a/py/source/structures/point_cloud/scalar_quantities.md b/py/source/structures/point_cloud/scalar_quantities.md
@@ -40,4 +40,4 @@ ps.show()
 
     This function also accepts optional keyword arguments listed below, which customize the appearance and behavior of the quantity.
     
-{!common/scalar_quantity.md!}
+[[% include 'common/scalar_quantity.md' %]]
diff --git a/py/source/structures/point_cloud/vector_quantities.md b/py/source/structures/point_cloud/vector_quantities.md
@@ -38,4 +38,4 @@ ps.show()
     This function also accepts optional keyword arguments listed below, which customize the appearance and behavior of the quantity.
    
 
-{!common/vector_quantity.md!}
+[[% include 'common/vector_quantity.md' %]]
diff --git a/py/source/structures/surface_mesh/color_quantities.md b/py/source/structures/surface_mesh/color_quantities.md
@@ -83,4 +83,4 @@ The filter mode can be set as an additional argument to adjust how values are sa
 
     
     
-{!common/color_quantity.md!}
+[[% include 'common/color_quantity.md' %]]
diff --git a/py/source/structures/surface_mesh/parameterization_quantities.md b/py/source/structures/surface_mesh/parameterization_quantities.md
@@ -81,4 +81,4 @@ Additionally, the seams of a parameterization can be visualized as a [curve netw
     
     - `create_curve_network_from_seams` is the **string** name of the the curve network quantity that will be created. Passing `""` generates a default fname
 
-{!common/parameterization_quantity.md!}
+[[% include 'common/parameterization_quantity.md' %]]
diff --git a/py/source/structures/surface_mesh/scalar_quantities.md b/py/source/structures/surface_mesh/scalar_quantities.md
@@ -94,4 +94,4 @@ The texture image data, dimension, and origin conventions are the same as those
 
 The filter mode can be set as an additional argument to adjust how values are sampled from the texture. `filter_mode='linear'` (default) will smoothly linearly interpolate values, while `filter_mode='nearest'` will use nearest-neighbor sampling, which can be useful for sharp edges and crisp boundaries.
 
-{!common/scalar_quantity.md!}
+[[% include 'common/scalar_quantity.md' %]]
diff --git a/py/source/structures/surface_mesh/vector_quantities.md b/py/source/structures/surface_mesh/vector_quantities.md
@@ -77,4 +77,4 @@ _One forms_ are tangent vector-like quantities represented as integrated scalars
     This function also accepts optional keyword arguments listed below, which customize the appearance and behavior of the quantity.
    
 
-{!common/vector_quantity.md!}
+[[% include 'common/vector_quantity.md' %]]
diff --git a/py/source/structures/volume_grid/scalar_quantities.md b/py/source/structures/volume_grid/scalar_quantities.md
@@ -61,7 +61,7 @@ ps.show()
 
     This function also accepts optional keyword arguments listed below, which customize the appearance and behavior of the quantity.
 
-{!common/scalar_quantity.md!}
+[[% include 'common/scalar_quantity.md' %]]
 
 ### Visualizing Isosurfaces
 
diff --git a/py/source/structures/volume_mesh/color_quantities.md b/py/source/structures/volume_mesh/color_quantities.md
@@ -32,4 +32,4 @@ ps.show()
     This function also accepts optional keyword arguments listed below, which customize the appearance and behavior of the quantity.
 
     
-{!common/color_quantity.md!}
+[[% include 'common/color_quantity.md' %]]
diff --git a/py/source/structures/volume_mesh/scalar_quantities.md b/py/source/structures/volume_mesh/scalar_quantities.md
@@ -42,4 +42,4 @@ ps.show()
 
 Slice planes have [special functionality]([[url.prefix]]/features/slice_planes/#inspecting-volume-meshes) for volume mesh vertex values---they can _inspect_ quantities on volume meshes and render them on the interior of the volume. See the slice plane documentation for details.
 
-{!common/scalar_quantity.md!}
+[[% include 'common/scalar_quantity.md' %]]
diff --git a/py/source/structures/volume_mesh/vector_quantities.md b/py/source/structures/volume_mesh/vector_quantities.md
@@ -32,4 +32,4 @@ ps.show()
     This function also accepts optional keyword arguments listed below, which customize the appearance and behavior of the quantity.
    
 
-{!common/vector_quantity.md!}
+[[% include 'common/vector_quantity.md' %]]

Original file line number	Diff line number	Diff line change
`@@ -31,4 +31,4 @@ polyscope::getCurveNetwork(curveNetworkName)->addEdgeColorQuantity("random color`
`31`	`31`
`32`	`32`	RGB values are interpreted in the range `[0,1]`.
`33`	`33`
`34`		`-{!common/color_quantity.md!}`
	`34`	`+[[% include 'common/color_quantity.md' %]]`
Original file line number	Diff line number	Diff line change
`@@ -30,4 +30,4 @@ polyscope::getCurveNetwork(curveNetworkName)->addNodeScalarQuantity("sample valu`
`30`	`30`	- `values` is the array of scalars at edges . The type should be [adaptable]([[url.prefix]]/data_adaptors) to a `float` scalar array. The length should be the number of edges in the curve network.
`31`	`31`
`32`	`32`
`33`		`-{!common/scalar_quantity.md!}`
	`33`	`+[[% include 'common/scalar_quantity.md' %]]`
Original file line number	Diff line number	Diff line change
`@@ -37,4 +37,4 @@ polyscope::show();`
`37`	`37`	Note: the inner vector type of the input _must_ be 3D dimensional, or you risk compiler errors, segfaults, or worse. If you want to add 2D vectors (usually to a 2D curve network), `addEdgeVectorQuantity2D` exists with the same signature. See [2D data]([[url.prefix]]/features/2D_data).
`38`	`38`
`39`	`39`
`40`		`-{!common/vector_quantity.md!}`
	`40`	`+[[% include 'common/vector_quantity.md' %]]`
Original file line number	Diff line number	Diff line change
`@@ -22,4 +22,4 @@ polyscope::getPointCloud(pointCloudName)->addColorQuantity("random color", randC`
`22`	`22`	RGB values are interpreted in the range `[0,1]`.
`23`	`23`
`24`	`24`
`25`		`-{!common/color_quantity.md!}`
	`25`	`+[[% include 'common/color_quantity.md' %]]`
Original file line number	Diff line number	Diff line change
`@@ -25,4 +25,4 @@ Typically parameterizations are used on meshes (which is also supported in Polys`
`25`	`25`	- `type` the default interpretation of the coordinate scale, see below
`26`	`26`
`27`	`27`
`28`		`-{!common/parameterization_quantity.md!}`
	`28`	`+[[% include 'common/parameterization_quantity.md' %]]`
Original file line number	Diff line number	Diff line change
`@@ -20,4 +20,4 @@ polyscope::getPointCloud(pointCloudName)->addScalarQuantity("xC", xC);`
`20`	`20`	- `values` is the array of scalars at points. The type should be [adaptable]([[url.prefix]]/data_adaptors) to a `float` scalar array. The length should be the number of points in the point cloud.
`21`	`21`
`22`	`22`
`23`		`-{!common/scalar_quantity.md!}`
	`23`	`+[[% include 'common/scalar_quantity.md' %]]`
Original file line number	Diff line number	Diff line change
`@@ -9,4 +9,4 @@ Visualize vector-valued data at the points of a point cloud.`
`9`	`9`
`10`	`10`	Note: the inner vector type of the input _must_ be 3D dimensional, or you risk compiler errors, segfaults, or worse. If you want to add 2D vectors (usually to a 2D point cloud), `addVectorQuantity2D` exists with the same signature. See [2D data]([[url.prefix]]/features/2D_data).
`11`	`11`
`12`		`-{!common/vector_quantity.md!}`
	`12`	`+[[% include 'common/vector_quantity.md' %]]`