Skip to content

Add docs generation.#109

Merged
catilac merged 2 commits intoprocessing:mainfrom
tychedelia:docs-gen
Apr 14, 2026
Merged

Add docs generation.#109
catilac merged 2 commits intoprocessing:mainfrom
tychedelia:docs-gen

Conversation

@tychedelia
Copy link
Copy Markdown
Member

The docs are generated from the .pyi stubs that generate_stubs already produces. mkdocstrings reads them via griffe's static analysis to build the docs. Apparently this is best practice, there's no single rustdocs equivalent.

A couple things worth noting:

  • I had to set module.incomplete = false in generate_stubs because pyo3-introspection marks the module incomplete due to some python things I'm not sure about.
  • allow_inspection: false tells giraffe to use the .pyi files.
  • show_if_no_docstring: true is needed because the stubs don't have docstrings yet
  • We should, in theory, be able to deploy this to github pages for now, which is what the CI sets up.

@catilac catilac merged commit e08ca83 into processing:main Apr 14, 2026
3 of 4 checks passed
@catilac
Copy link
Copy Markdown
Contributor

catilac commented Apr 14, 2026

yay! thanks so much! noted the notes.

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.

2 participants