Skip to content

Document cross-link feature in library docs generator #5453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
devalog merged 3 commits into from
May 11, 2026
+3 −1
Merged

Document cross-link feature in library docs generator #5453

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d29b95d
Document cross-link feature in library docs generator
fern-api[bot] May 11, 2026
0211b1a
Condense cross-link mention into intro and fix Vale issues
fern-api[bot] May 11, 2026
79bb14f
clean up explanation
devalog May 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion fern/products/docs/pages/api-references/library-docs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ description: Generate MDX documentation pages from your Python or C++ library so
---


The library docs generator parses your **Python or C++** library source code and generates MDX documentation pages for modules, classes, functions, methods, and parameters. Generated pages include cross-reference links and hierarchical navigation, and are integrated directly into your Fern Docs site.
The library docs generator parses your **Python or C++** library source code and generates MDX documentation pages for modules, classes, functions, methods, and parameters. Generated pages are added to your Fern Docs site with hierarchical navigation.

Cross-links are automatic. When a fully-qualified identifier appears in a code block — for example, in a class signature or type annotation — the generator links it to the page documenting that symbol, so readers can jump straight to the definition.
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot May 11, 2026

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[FernStyles.Hyphens] 'fully-qualified' doesn't need a hyphen.


## Configuration

Expand Down
Loading