Skip to content

fix: add mkdocstrings[python] to uvx invocations in docs.mk#904

Closed
Copilot wants to merge 3 commits intomainfrom
copilot/add-mkdocstrings-to-uvx-invocations
Closed

fix: add mkdocstrings[python] to uvx invocations in docs.mk#904
Copilot wants to merge 3 commits intomainfrom
copilot/add-mkdocstrings-to-uvx-invocations

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 24, 2026

Summary

mkdocs-build and mkdocs-serve targets in docs.mk were missing --with "mkdocstrings[python]", causing API reference generation via mkdocstrings to silently fail.

Changes

  • Added --with "mkdocstrings[python]" to the uvx invocation in mkdocs-build
  • Added --with "mkdocstrings[python]" to the uvx invocation in mkdocs-serve
# both targets now include:
${UVX_BIN} --with "mkdocs-material<10.0" --with "pymdown-extensions>=10.0" --with "mkdocs<2.0" --with "mkdocstrings[python]" mkdocs build ...

Testing

  • make test passes locally
  • make fmt has been run
  • New tests added (or explain why not needed): No tests needed — single-line Makefile flag addition

Checklist

  • Commit messages follow the Conventional Commits format
  • Documentation updated if behaviour changed
  • make deptry passes (no unused or missing dependencies)
Original prompt

This section details on the original issue you should resolve

<issue_title>fix: add mkdocstrings[python] to uvx invocations in docs.mk</issue_title>
<issue_description>## Background

Developed in tschm/jquantstats and ready to be pulled into the rhiza template.

Change

Both mkdocs-build and mkdocs-serve targets in docs.mk are missing --with "mkdocstrings[python]" in their uvx invocations. Without it, API reference generation via mkdocstrings does not work.

Add --with "mkdocstrings[python]" to both targets:

```makefile

mkdocs-build

${UVX_BIN} --with "mkdocs-material<10.0" --with "pymdown-extensions>=10.0" --with "mkdocs<2.0" --with "mkdocstrings[python]" mkdocs build ...

mkdocs-serve

${UVX_BIN} --with "mkdocs-material<10.0" --with "pymdown-extensions>=10.0" --with "mkdocs<2.0" --with "mkdocstrings[python]" mkdocs serve ...
```

Source commit: 51b3db2 in tschm/jquantstats</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.

Copilot AI changed the title [WIP] Fix: add mkdocstrings[python] to uvx invocations in docs.mk fix: add mkdocstrings[python] to uvx invocations in docs.mk Mar 24, 2026
Copilot AI requested a review from tschm March 24, 2026 07:06
@tschm tschm marked this pull request as ready for review March 25, 2026 02:28
@tschm tschm closed this Mar 27, 2026
@tschm tschm deleted the copilot/add-mkdocstrings-to-uvx-invocations branch March 27, 2026 10:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix: add mkdocstrings[python] to uvx invocations in docs.mk

3 participants