Prep 2.5

[adam-urbanczyk]

• Merge outstanding PRs (Fix workplane cylinder center when generated using a custom direction #1593, Set version in docs automatically from metadata #1713)
• Final pass on free funcs (Final shape / free func tweaks #1731)
• Add arbitrary vtkActor rendering capabilities (cq.vis.show improvements #1726)
• Restructure docs (Docs cleanup #1736)
• Set version in docs automatically from metadata #1713
• Header cleanup #1732

[adam-urbanczyk]

@jmwright @lorenzncode is there anything you'd like to add to the list?

[jmwright]

I don't have any tasks to add. I don't know if I will get to implementing the CI to automate releases before this release is needed, but I have created documentation on how to do releases.

https://github.com/CadQuery/cadquery/wiki/Developer-Doc:-Creating-a-New-Release

[huskier]

Prior to the release of V2.5.0, I recommend enhancing the show function in the vis.py file by adding a new parameter named "title", which defaults to "CQ viewer". Sometimes, it is useful to differentiate between different display windows.

win.SetWindowName("CQ viewer")

def show(
    *objs: Showable,
    scale: float = 0.2,
    alpha: float = 1,
    tolerance: float = 1e-3,
    edges: bool = False,
    **kwrags: Any,
):
    """
    Show CQ objects using VTK.
    """
    ......
    # create a VTK window
    win = _vtkRenderWindow(assy, tolerance=tolerance)

    win.SetWindowName("CQ viewer")

[lorenzncode]

I have only #1713. As part of that I need to check whether any changes are required for the sphinx multimethod customization with sphinx version bump (and perhaps consider trying the sphinx-immaterial theme for docs as mentioned in #1697?).