docs(api): generate API docs from latest PyPI release

[mishaldholakia]

Misc PR

Type of PR

• Bug Fix
• New Feature
• Documentation
• Other

Description

• Link to Issue:

Testing

• Tests added to the respective file if code was changed
• New code has 100% coverage if code as added
• Ensure existing tests and github automation passes (a maintainer will kick off the github automation when the rest of the PR is populated)

[github-actions]

The PR description has been updated. Please fill out the template for your PR to be reviewed.

[mergify]

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 Enforce conventional commit

Wonderful, this rule succeeded.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

• title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert|release)(?:\(.+\))?:

[mishaldholakia]

Description

This PR updates the API documentation pipeline to automatically generate docs from the latest published PyPI release of mellea, instead of relying on a GitHub checkout.

The goal is to ensure the documentation always reflects what users actually install via pip, while keeping the process safe, deterministic, and CI-friendly.

---

What Changed

• API docs are generated from the latest PyPI wheel of mellea
• The workflow checks for an existing docs/docs/api/ directory and only regenerates docs when needed
• Mintlify navigation is rebuilt cleanly under the API Reference tab
  • Top-level groups are only mellea and cli
  • Navigation paths do not include .mdx extensions
• Existing non-API documentation remains untouched

---

Scope & Impact

• Documentation tooling and CI only
• No runtime or library behavior changes
• Safe to re-run; output is deterministic

---

Testing

• Verified documentation generation against the latest PyPI release
• Confirmed missing optional dependencies are handled without breaking the pipeline
• Confirmed Mintlify navigation updates correctly

[planetf1]

Does this effectively address much #341 by migrating the doc build into the core repo - and triggering when a new release is created (to be consistent with pypi as mentioned) ?

I think it's a super improvement. One gotcha could be any devs working off a clone, but that is a lessor issue - smaller community & more aware. Might be worth adding a note in the readme or contribution guide that they should refer to the authoratative code in github repo (is there a way for them to render locally?)

[mishaldholakia]

@planetf1 This covers the #341. Also there is a READ which covers how you run it locally: https://github.com/generative-computing/mellea/tree/feat/integrate-external-docs/docs

[psschwei]

There have been some updates to the tutorial, etc. since this PR was opened, but I'd lean towards merging this as-is and then making additional updates in subsequent PRs.

[planetf1]

There have been some updates to the tutorial, etc. since this PR was opened, but I'd lean towards merging this as-is and then making additional updates in subsequent PRs.

I agree - this change can at least get the content migrated back into the same repo as code - then we can do consolidation/correction after

[jakelorocco]

lgtm; we should make sure the process works for today's release