Docs update

[benoitdenkinger]

Documentation

• Upgraded Docusaurus to v3.10.1
• Fixed API docs Sphinx generation; renamed conf.py.in → conf.py.jinja and added a master_doc.rst.jinja template
• Updated Python source docstrings (__peakrdl__.py, halnode.py, halutils.py, exporter.py)
• Updated CLI docs to document -f / --peakrdl-cfg arguments
• Updated docs README to reflect the CMake-based build flow
• Fixed broken links, typos, and Docusaurus editUrl config
• Added version display to generated HTML pages (version read from the Python package)
• Added license mention in the introduction page

CI/CD

• Replaced the old deploy.yml and test-deploy.yml workflows with:
  • pages.yml — builds and deploys docs to GitHub Pages on every push to master
  • pages_preview.yml — builds and publishes a per-PR preview (e.g. .../pr-preview/pr-123/) when docs files change or the preview-docs label is added; cleans up automatically on PR close
• Extracted a reusable build-docs composite action (.github/actions/build-docs/) shared by both workflows
• Restricted PyPI package deployment (build.yml) to tag pushes only (was triggering on every push to master)
• Removed the now-irrelevant test-deploy.yml workflow

Packaging

• Renamed the setuptools package from peakrdl-halcpp to peakrdl_halcpp in setup.py for PyPI/PEP 625 naming compatibility

[github-actions]

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-06-26 08:30 UTC