Document Cython .pyx module support in the Python library docs generator - #7221
Open
fern-api[bot] wants to merge 3 commits into
Open
fern-api[bot] wants to merge 3 commits into
fern-api[bot] wants to merge 3 commits into
Conversation
fern-api
Bot
requested review from
jkonrath-postman and
nerminamiller-postman
as code owners
October 1, 2026 20:31
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>
.pyx module support in the Python library docs generator
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The Python library docs generator now documents Cython
.pyxmodules automatically. Before this change, Cython-heavy packages had incomplete reference docs unless the authors maintained.pyistubs. Any.pyxfile without a.pyor.pyifile 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## Cython modulessection placed after Customize generated docs and before Configuration reference. It no longer sits between the intro and Configuration. It covers:.pyxfiles are documented (no sibling.py/.pyi).class/cdef class,def/cpdefwith full signatures,cdef public/cdef readonlyattributes and properties, docstrings,__all__, constants, and imports.cdeffunctions, privatecdefattributes,ctypedef,cimport, andinclude. C types are mapped to Python types only where the mapping is unambiguous.fern docs md generateprints a non-fatal warning. Verified againstorchestrate.tsin fern-api/fern (CLI 5.144.2).Link to Devin session: https://app.devin.ai/sessions/f58dda5bf6eb40d8bad5ee9284244ce9
Open in Devin Desktop: https://app.devin.ai/desktop/session/f58dda5bf6eb40d8bad5ee9284244ce9?variant=devin