fix docs generation in CI

[peter-mitrano-ar]

Summary by Sourcery

Update documentation contribution instructions and fix documentation build requirements in CI.

CI:

• Install Hatch in the documentation deployment workflow to satisfy docs build tooling requirements.

Documentation:

• Clarify documentation setup to use make install-dev, require manual doxygen installation, and refer to make docs-build for syncing docs.

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates documentation instructions and CI workflow to reflect the current docs build process, including using make targets, requiring doxygen, and installing hatch in the deploy workflow.

Flow diagram for updated documentation contribution instructions

flowchart TD
  A["Start: Want_to_contribute_docs"] --> B["Run_make_install_dev"]
  B --> C["Install_doxygen_and_add_to_PATH"]
  C --> D["Edit_root_README_md_and_docs_folder_files"]
  D --> E["Run_make_docs_build_to_update_docs_directory"]
  E --> F["Run_make_docs_serve_and_open_localhost_8000"]
  F --> G["Review_changes_and_iterate"]
  G --> H["Submit_PR_with_updated_docs"]

Loading

File-Level Changes

Change	Details	Files
Align documentation authoring instructions with the current docs build process and tooling.	Replace pip-based docs dependency installation with make install-dev and a manual doxygen requirement in contributor docs Update instructions for syncing root README to docs from using a make macro to using make docs-build Mirror these documentation instruction updates in both the root CONTRIBUTING.md and docs/CONTRIBUTING.md	CONTRIBUTING.md docs/CONTRIBUTING.md
Ensure CI and local docs instructions include required tooling for docs generation.	Add a step in the deploy-web GitHub Actions workflow to install hatch before building docs Document that doxygen must be installed and on PATH for local documentation builds in docs/README.md	.github/workflows/deploy-web.yaml docs/README.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've found 1 issue, and left some high level feedback:

• The new CI step name has a typo (Install Hathch); consider renaming it to Install Hatch for clarity and consistency.
• Since the docs recommend a specific Hatch version (hatch==1.15.1 via pipx), consider aligning the CI pip install hatch with that version (or explaining why CI uses an unpinned/latest Hatch) to avoid version drift between local and CI builds.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- The new CI step name has a typo (`Install Hathch`); consider renaming it to `Install Hatch` for clarity and consistency.
- Since the docs recommend a specific Hatch version (`hatch==1.15.1` via pipx), consider aligning the CI `pip install hatch` with that version (or explaining why CI uses an unpinned/latest Hatch) to avoid version drift between local and CI builds.

## Individual Comments

### Comment 1
<location> `.github/workflows/deploy-web.yaml:22` </location>
<code_context>
       - uses: actions/setup-python@v5
         with:
           python-version: "3.12"
+      - name: Install Hathch
+        run: pip install hatch
       - uses: actions/cache@v4
</code_context>

<issue_to_address>
**nitpick (typo):** Typo in step name ('Hathch' -> 'Hatch').

Renaming the step to `Install Hatch` will make the workflow logs clearer and more readable.

```suggestion
      - name: Install Hatch
```
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}