Skip to content

Document Cython .pyx module support in the Python library docs generator - #7221

Open
fern-api[bot] wants to merge 3 commits into
mainfrom
2026-10-01-fern-ai-1fb7a4-6d812870
Open

fern-api[bot] wants to merge 3 commits into
mainfrom
2026-10-01-fern-ai-1fb7a4-6d812870

Conversation

@fern-api

@fern-api fern-api Bot commented Oct 1, 2026 •

Copy link
Copy Markdown
Contributor

Summary

The Python library docs generator now documents Cython .pyx modules automatically. Before this change, Cython-heavy packages had incomplete reference docs unless the authors maintained .pyi stubs. Any .pyx file without a .py or .pyi file of the same name now gets pages for its Python-visible API, with no configuration. A module that fails to parse is skipped with a CLI warning, and the rest of the library is still documented.

Implements docs for: feat(fdr): native Cython .pyx support in Python library docs parser (fern-api/fern-platform#14949)

Changes to fern/products/docs/pages/api-references/library-docs.mdx

  • New ## Cython modules section placed after Customize generated docs and before Configuration reference. It no longer sits between the intro and Configuration. It covers:
    • When .pyx files are documented (no sibling .py/.pyi).
    • What's included: class/cdef class, def/cpdef with full signatures, cdef public/cdef readonly attributes and properties, docstrings, __all__, constants, and imports.
    • What's excluded: cdef functions, private cdef attributes, ctypedef, cimport, and include. C types are mapped to Python types only where the mapping is unambiguous.
    • Parse failures: the module is skipped and fern docs md generate prints a non-fatal warning. Verified against orchestrate.ts in fern-api/fern (CLI 5.144.2).
  • Removed the implementation details (stub synthesis and Griffe) and the exact warning string.

Link to Devin session: https://app.devin.ai/sessions/f58dda5bf6eb40d8bad5ee9284244ce9
Open in Devin Desktop: https://app.devin.ai/desktop/session/f58dda5bf6eb40d8bad5ee9284244ce9?variant=devin

@github-actions

github-actions Bot commented Oct 1, 2026 •

Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://fern-preview-2026-10-01-fern-ai-1fb7a4-6d812870.docs.buildwithfern.com/learn

Here are the markdown pages you've updated:

…havior only

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration devin-ai-integration Bot changed the title Add Cython support section to library docs generator page Document Cython .pyx module support in the Python library docs generator Oct 3, 2026
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.

0 participants