Skip to content

Commit b9bd6fc

Browse files
committed
removed test files
1 parent 590c1ae commit b9bd6fc

File tree

240 files changed

+9
-25479
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

240 files changed

+9
-25479
lines changed

README.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,27 +15,23 @@ pipx install py2fern
1515
Generate Fern markdown documentation:
1616

1717
```bash
18-
py2fern /path/to/your/package
18+
py2fern write /path/to/your/package
1919
```
2020

21-
This creates:
21+
Specify output directory:
2222

23-
- Markdown files with Fern-compatible frontmatter and slugs
24-
- `navigation.yml` for Fern docs structure
25-
- Tables with proper linking and descriptions
23+
```bash
24+
py2fern write /path/to/your/package --output ./docs/api
25+
```
26+
27+
This creates:
28+
- **MDX files** with Fern-compatible frontmatter and slugs
29+
- **`navigation.yml`** for Fern docs structure
2630

2731
## Acknowledgments
2832

2933
This project is a fork of the excellent [`sphinx-autodoc2`](https://github.com/sphinx-extensions2/sphinx-autodoc2) by Chris Sewell. All credit for the core functionality goes to the original project.
3034

31-
## Features
32-
33-
- **Static analysis** - No need to install your package
34-
- **Handles `TYPE_CHECKING` blocks** - Documents typing-only imports
35-
- **Follows `__all__`** - Only documents public API
36-
- **Fern-ready output** - Frontmatter, slugs, ParamField components
37-
- **Navigation generation** - Automatic `navigation.yml` for Fern docs
38-
3935
## Development
4036

4137
All configuration is mainly in `pyproject.toml`.

0 commit comments

Comments
 (0)