Add beta documentation for Python and C++ library docs generation#4158
Open
devin-ai-integration[bot] wants to merge 3 commits intomainfrom
Open
Add beta documentation for Python and C++ library docs generation#4158devin-ai-integration[bot] wants to merge 3 commits intomainfrom
devin-ai-integration[bot] wants to merge 3 commits intomainfrom
Conversation
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
Requested by: ryan stephen |
Contributor
|
🌿 Preview your docs: https://fern-preview-2d4243b6-71a9-4654-8a1a-ca9aac1aaad8.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
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
Adds a new documentation page (
generate-library-docs.mdx) describing how to generate library documentation for Python and C++ projects using Fern. The page is:availability: betafrontmatter and a warning callouthidden: trueindocs.yml) under API References > Generation/learn/docs/api-references/generate-library-docsThe page covers configuration in
docs.ymlusing thelibrarieskey, withParamFieldproperty reference, language-specific examples (Python and C++), multi-library setup, CLI commands to generate and preview docs, and guidance on writing effective source comments (Google-style docstrings for Python, Doxygen for C++). Uses plant-themed examples consistent with other docs pages.Updates since last revision
ParamFieldpaths: Changed from verboselibraries.<name>.langto justlang,input.git, etc.config.doxyfiledescription now links to the Doxygen configuration docs.fern docs devfor local preview,fern generate --docsto publish).Review & Testing Checklist for Human
docs.ymllibrariesschema is accurate: The config was written based on a screenshot of the schema. Confirm thatinput.git,input.subpath,output.path,lang, andconfig.doxyfilematch the actual implementation. Pay attention to field names and nesting.fern docs dev(preview) andfern generate --docs(publish). Since this is a beta feature, verify these are the correct commands and that library docs generation is triggered through the standard docs pipeline.gitis the only supported input type: The page states onlygitinput is supported. Verify no other input types (e.g., localpath) are available.config.doxyfilebehavior: Page states the Doxyfile is read from disk and sent as raw content to the backend. Verify this is correct and C++-only.fern docs devand visit the page directly to verify it renders correctly with all components (ParamField,Tabs, code blocks, table).Notes
fern docs dev— rendering should be verified manually.Requested by: Fern Support
Link to Devin Session