@fern-api/fern-api-dev 3.41.1 → 3.42.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cli.cjs +64 -20
- package/package.json +1 -1
package/cli.cjs
CHANGED
|
@@ -1415659,7 +1415659,7 @@ var AccessTokenPosthogManager = class {
|
|
|
1415659
1415659
|
properties: {
|
|
1415660
1415660
|
...event,
|
|
1415661
1415661
|
...event.properties,
|
|
1415662
|
-
version: "3.
|
|
1415662
|
+
version: "3.42.0",
|
|
1415663
1415663
|
usingAccessToken: true
|
|
1415664
1415664
|
}
|
|
1415665
1415665
|
});
|
|
@@ -1415758,7 +1415758,7 @@ var UserPosthogManager = class {
|
|
|
1415758
1415758
|
distinctId: this.userId ?? await this.getPersistedDistinctId(),
|
|
1415759
1415759
|
event: "CLI",
|
|
1415760
1415760
|
properties: {
|
|
1415761
|
-
version: "3.
|
|
1415761
|
+
version: "3.42.0",
|
|
1415762
1415762
|
...event,
|
|
1415763
1415763
|
...event.properties,
|
|
1415764
1415764
|
usingAccessToken: false,
|
|
@@ -1495949,7 +1495949,7 @@ var CliContext = class {
|
|
|
1495949
1495949
|
if (false) {
|
|
1495950
1495950
|
this.logger.error("CLI_VERSION is not defined");
|
|
1495951
1495951
|
}
|
|
1495952
|
-
return "3.
|
|
1495952
|
+
return "3.42.0";
|
|
1495953
1495953
|
}
|
|
1495954
1495954
|
getCliName() {
|
|
1495955
1495955
|
if (false) {
|
|
@@ -1582513,7 +1582513,7 @@ https://buildwithfern.com/learn/docs/getting-started/project-structure#api-defin
|
|
|
1582513
1582513
|
link: async (value) => this.toLinkNode(value),
|
|
1582514
1582514
|
changelog: async (value) => this.toChangelogNode(value, parentSlug),
|
|
1582515
1582515
|
// Library sections are handled by FDR during registration, returning placeholder
|
|
1582516
|
-
pythonDocsSection: async () => this.toPythonDocsSectionPlaceholder(parentSlug)
|
|
1582516
|
+
pythonDocsSection: async (value) => this.toPythonDocsSectionPlaceholder(value, parentSlug)
|
|
1582517
1582517
|
});
|
|
1582518
1582518
|
}
|
|
1582519
1582519
|
async toNavigationChild({ prefix: prefix2, item, parentSlug, hideChildren, parentAvailability }) {
|
|
@@ -1582524,7 +1582524,7 @@ https://buildwithfern.com/learn/docs/getting-started/project-structure#api-defin
|
|
|
1582524
1582524
|
link: async (value) => this.toLinkNode(value),
|
|
1582525
1582525
|
changelog: async (value) => this.toChangelogNode(value, parentSlug, hideChildren),
|
|
1582526
1582526
|
// Library sections are handled by FDR during registration, returning placeholder
|
|
1582527
|
-
pythonDocsSection: async () => this.toPythonDocsSectionPlaceholder(parentSlug)
|
|
1582527
|
+
pythonDocsSection: async (value) => this.toPythonDocsSectionPlaceholder(value, parentSlug)
|
|
1582528
1582528
|
});
|
|
1582529
1582529
|
}
|
|
1582530
1582530
|
async toApiSectionNode({ item, parentSlug, hideChildren, parentAvailability }) {
|
|
@@ -1582642,28 +1582642,72 @@ https://buildwithfern.com/learn/docs/getting-started/project-structure#api-defin
|
|
|
1582642
1582642
|
* The CLI starts the generation job, polls for completion, and passes the jobId to FDR.
|
|
1582643
1582643
|
* FDR then merges the generated Python docs into the navigation.
|
|
1582644
1582644
|
*
|
|
1582645
|
-
*
|
|
1582645
|
+
* In dev mode (fern docs dev), this placeholder returns a visible page with helpful content
|
|
1582646
|
+
* explaining that Python library docs are only generated during `fern generate --docs`.
|
|
1582647
|
+
*
|
|
1582648
|
+
* In production mode, FDR replaces/augments this with the actual generated documentation.
|
|
1582646
1582649
|
*/
|
|
1582647
|
-
toPythonDocsSectionPlaceholder(parentSlug) {
|
|
1582648
|
-
const
|
|
1582650
|
+
toPythonDocsSectionPlaceholder(item, parentSlug) {
|
|
1582651
|
+
const title5 = item.title ?? "Python Reference";
|
|
1582652
|
+
const urlSlug = item.slug ?? "python-docs";
|
|
1582653
|
+
const slug = parentSlug.apply({ urlSlug });
|
|
1582654
|
+
const syntheticPageId = `__python-docs-placeholder-${urlSlug}__.mdx`;
|
|
1582655
|
+
const pageId = navigation_exports2.PageId(syntheticPageId);
|
|
1582656
|
+
const placeholderMarkdown = `---
|
|
1582657
|
+
title: ${title5}
|
|
1582658
|
+
---
|
|
1582659
|
+
|
|
1582660
|
+
<Warning>
|
|
1582661
|
+
Python library documentation is not yet supported with \`fern docs dev\`. This feature will be added in a future release. To view the generated documentation, run \`fern generate --docs --preview\`.
|
|
1582662
|
+
</Warning>
|
|
1582663
|
+
|
|
1582664
|
+
## About Python Library Docs
|
|
1582665
|
+
|
|
1582666
|
+
When you publish your documentation using \`fern generate --docs\`, Fern will:
|
|
1582667
|
+
|
|
1582668
|
+
1. Clone and analyze your Python repository from: \`${item.githubUrl}\`
|
|
1582669
|
+
2. Parse the Python source code to extract docstrings and type information
|
|
1582670
|
+
3. Generate comprehensive API reference documentation
|
|
1582671
|
+
4. Integrate the generated docs into your documentation site
|
|
1582672
|
+
|
|
1582673
|
+
## How to Generate
|
|
1582674
|
+
|
|
1582675
|
+
To generate the full Python library documentation, run:
|
|
1582676
|
+
|
|
1582677
|
+
\`\`\`bash
|
|
1582678
|
+
fern generate --docs
|
|
1582679
|
+
\`\`\`
|
|
1582680
|
+
|
|
1582681
|
+
Or to preview without publishing:
|
|
1582682
|
+
|
|
1582683
|
+
\`\`\`bash
|
|
1582684
|
+
fern generate --docs --preview
|
|
1582685
|
+
\`\`\`
|
|
1582686
|
+
|
|
1582687
|
+
The generated documentation will replace this placeholder page with complete API reference content including:
|
|
1582688
|
+
|
|
1582689
|
+
- Module and package documentation
|
|
1582690
|
+
- Class and function references
|
|
1582691
|
+
- Type annotations and signatures
|
|
1582692
|
+
- Docstring content
|
|
1582693
|
+
`;
|
|
1582694
|
+
this.parsedDocsConfig.pages[RelativeFilePath2.of(syntheticPageId)] = placeholderMarkdown;
|
|
1582695
|
+
const id2 = this.#idgen.get(pageId);
|
|
1582649
1582696
|
return {
|
|
1582650
|
-
|
|
1582651
|
-
|
|
1582697
|
+
id: id2,
|
|
1582698
|
+
type: "page",
|
|
1582652
1582699
|
slug: slug.get(),
|
|
1582653
|
-
title:
|
|
1582654
|
-
collapsed: false,
|
|
1582655
|
-
hidden: true,
|
|
1582656
|
-
// Hidden - actual content comes from FDR
|
|
1582657
|
-
children: [],
|
|
1582658
|
-
overviewPageId: void 0,
|
|
1582700
|
+
title: title5,
|
|
1582659
1582701
|
icon: void 0,
|
|
1582702
|
+
hidden: false,
|
|
1582660
1582703
|
viewers: void 0,
|
|
1582661
1582704
|
orphaned: void 0,
|
|
1582705
|
+
pageId,
|
|
1582662
1582706
|
authed: void 0,
|
|
1582663
|
-
|
|
1582664
|
-
|
|
1582707
|
+
noindex: true,
|
|
1582708
|
+
// Don't index placeholder pages
|
|
1582665
1582709
|
featureFlags: void 0,
|
|
1582666
|
-
|
|
1582710
|
+
availability: void 0
|
|
1582667
1582711
|
};
|
|
1582668
1582712
|
}
|
|
1582669
1582713
|
async toPageNode({ item, parentSlug, hideChildren, parentAvailability }) {
|
|
@@ -1591686,7 +1591730,7 @@ var import_path37 = __toESM(require("path"), 1);
|
|
|
1591686
1591730
|
var LOCAL_STORAGE_FOLDER4 = ".fern-dev";
|
|
1591687
1591731
|
var LOGS_FOLDER_NAME = "logs";
|
|
1591688
1591732
|
function getCliSource() {
|
|
1591689
|
-
const version6 = "3.
|
|
1591733
|
+
const version6 = "3.42.0";
|
|
1591690
1591734
|
return `cli@${version6}`;
|
|
1591691
1591735
|
}
|
|
1591692
1591736
|
var DebugLogger = class {
|
package/package.json
CHANGED