Skip to content

馃摑 Fix documentation build guidance - #438

Merged
burgholzer merged 1 commit into
mainfrom
docs/documentation-build-guidance
Sep 8, 2026
Merged

馃摑 Fix documentation build guidance#438
burgholzer merged 1 commit into
mainfrom
docs/documentation-build-guidance

Conversation

@burgholzer

@burgholzer burgholzer commented Sep 8, 2026

Copy link
Copy Markdown
Member

馃 AI text below 馃

Description

The development recipe builds the Python package before installing LLVM/MLIR,
and the documentation recipe bypasses the checked nox session. Move the native
prerequisite before the first package build and document the supported docs and
linkcheck commands. Describe Core's native Doxygen HTML while preserving Breathe
guidance for other projects.

Extend the existing render-and-format tests to cover Core as well as a generic
repository. Core #2462 consumes the rendered installation,
contribution, and tooling pages.

Validation: all 13 rendering tests passed; uv run prek run --all-files passed.
No runtime API or dependency changes. Hosted CI and human review are pending.
Codex implemented and validated this change under explicit user authorization.

Checklist

  • The pull request only contains commits that are focused and relevant to this change.
  • I have added appropriate tests that cover the new/changed functionality.
  • I have updated the documentation to reflect these changes.
  • I have added entries to the changelog for any noteworthy additions, changes, fixes, or removals.
  • I have added migration instructions to the upgrade guide (if needed).
  • The changes follow the project's style guidelines and introduce no new warnings.
  • The changes are fully tested and pass the CI checks.
  • I have reviewed my own code changes.

If PR contains AI-assisted content:

  • Any agent that created, edited, or submitted GitHub content was explicitly authorized for that scope, as required by our AI Usage Guidelines.
  • Every agent-authored or agent-edited public text body begins with the visible disclosure 馃 *AI text below* 馃 (titles are exempt).
  • I have disclosed AI assistance in the PR description.
  • I confirm that I have personally reviewed and understood all AI-generated content, and accept full responsibility for it.

Install LLVM/MLIR before the first package build and use the supported
nox documentation session. Describe Core's native Doxygen integration
while preserving Breathe guidance for other projects.

Assisted-by: Codex
@burgholzer burgholzer added documentation Improvements or additions to documentation fix Fixes something that is not working labels Sep 8, 2026
@burgholzer burgholzer self-assigned this Sep 8, 2026

@burgholzer burgholzer left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks fine to me 馃憤馃徏

@burgholzer
burgholzer merged commit 38a2369 into main Sep 8, 2026
9 checks passed
@burgholzer
burgholzer deleted the docs/documentation-build-guidance branch September 8, 2026 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation fix Fixes something that is not working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant