Skip to content

Commit 5b3c963

Browse files
committed
docs: include utility modules in Fern API reference
1 parent 67c67e5 commit 5b3c963

4 files changed

Lines changed: 7 additions & 0 deletions

File tree

fern/AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ This folder contains the Fern docs site for NeMo Data Designer. Use `fern/README
1313
## Generated Artifacts
1414

1515
- `make generate-fern-api-reference` creates gitignored API reference files in `fern/code-reference/`.
16+
- `py2fern` only descends into Python packages. Add `__init__.py` to any new subdirectory whose modules should appear in the API reference.
1617
- `make generate-fern-notebooks` creates gitignored notebook files in `fern/components/notebooks/`.
1718
- `docs/notebook_source/*.py` is the notebook source of truth.
1819
- `docs/colab_notebooks/` is only for Colab links, not Fern input.

fern/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ Two pre-render steps are needed before the dev server has all content. Both prod
3131
make generate-fern-api-reference
3232
```
3333

34+
`py2fern` only descends into Python packages. Add `__init__.py` to any new subdirectory whose modules should appear in the API reference.
35+
3436
The `libraries:` block in [`docs.yml`](docs.yml) still documents the equivalent Fern-native generator. Run `make generate-fern-api-reference-native` only when you want the Fern CLI output and have Fern auth.
3537

3638
Re-run when the upstream package source changes.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
# SPDX-License-Identifier: Apache-2.0
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
# SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)