No description
  • PostScript 99.1%
  • JavaScript 0.3%
  • CSS 0.2%
  • SCSS 0.2%
  • HTML 0.1%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Twice 0837226dd5
Fix namespace handling in MLIR Python API docs (#290)
MLIR Python uses implicit namespace packages, but AutoAPI does not
create namespace objects for those directories. The existing glob-based
workaround flattens and duplicates the navigation, while imports from
`_mlir_libs` are resolved incorrectly and public modules such as
`mlir.ir`, `mlir.passmanager`, and `mlir.rewrite` omit APIs supplied by
the native core stubs.

This creates a documentation-only regular-package view of the Python
sources so AutoAPI can build the actual module hierarchy and resolve the
core re-exports, then removes the globbed namespace index.

## Before:

<!-- screenshot -->

<img width="1799" height="1214" alt="image"
src="https://github.com/user-attachments/assets/efc40115-57ac-4c27-b394-2344daa31252"
/>

<img width="1850" height="1210" alt="image"
src="https://github.com/user-attachments/assets/2df12db5-bbc2-4352-a197-1020c42d9185"
/>


## After:

<!-- screenshot -->

<img width="1801" height="1013" alt="image"
src="https://github.com/user-attachments/assets/dd671818-fe0a-4246-911e-ae8c06684470"
/>

<img width="1783" height="1196" alt="image"
src="https://github.com/user-attachments/assets/fb959340-b9e5-485e-a058-a63bc24d3ed9"
/>


Assisted by: Codex / GPT 5.6 Sol
2026-08-23 13:45:58 -04:00
.github Bump actions/checkout from 6 to 7 (#283) 2026-06-23 09:57:23 -04:00
sphinx-mlir-python Fix namespace handling in MLIR Python API docs (#290) 2026-08-23 13:45:58 -04:00
website Bump @babel/core from 7.6.2 to 8.0.1 in /website/themes/mlir (#284) 2026-06-23 21:59:31 -04:00
.editorconfig Initial version of a website for MLIR 2019-11-29 20:21:38 -08:00
.gitattributes Advertise Markdown files in website/content/ as "source" files (#221) 2025-07-23 19:26:00 +02:00
.gitignore Update deps (#275) 2026-04-21 14:49:48 +02:00
build_pattern_catalog_index.py Add pattern catalog page to MLIR website (#230) 2025-08-26 09:19:32 +02:00
mlir-www-helper.sh Refactor workflow code into mlir-www-helper.sh (#160) 2023-10-26 14:56:39 -07:00
README.md Refactor workflow code into mlir-www-helper.sh (#160) 2023-10-26 14:56:39 -07:00

MLIR WWW

This contains the source code for https://mlir.llvm.org/ ; which is rendered from the gh-pages branch of the same repo using GitHub pages.

To contribute, feel free to fork this repository and send a pull-request.

The website is deployed on every push to this repository using a GitHub action defined in .github/workflows/main.yml. It also runs every 4 hours to catch updates from the MLIR source repository (the LLVM monorepo), which is used for generating some docs.

We are using the Hugo framework for generating the website. The source pages are written in Markdown format under the website/content folder.

A large part of the documentation is auto-generated from the MLIR source code. See the workflow .github/workflows/main.yml for the instructions to reproduce the entirety of https://mlir.llvm.org/ locally.

After running the code from the workflow, download hugo on your machine, and run hugo server from the website directory. You can then access a local version of the website from http://localhost:1313/; any change you make to the source Markdown will automatically be refreshed by the local hugo server.

When making changes it is often not useful to check out the doxygen branch so consider checking out only the main branch. For example, if using gh, only the following is needed

gh repo clone llvm/mlir-www -- --single-branch --branch main