| Name | py2fern JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | Generate Fern documentation from Python packages using static analysis. |
| upload_time | 2025-11-03 01:09:16 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
python
documentation
fern
api
static-analysis
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# py2fern
Generate [Fern](https://buildwithfern.com) API documentation from Python packages using static analysis.
Simplified fork of [`sphinx-autodoc2`](https://github.com/sphinx-extensions2/sphinx-autodoc2) focused purely on **Python → Fern markdown** output.
## Installation
```bash
pipx install py2fern
```
## Usage
Generate Fern markdown documentation:
```bash
py2fern write /path/to/your/package
```
Specify output directory:
```bash
py2fern write /path/to/your/package --output ./docs/api
```
This creates:
- **MDX files** with Fern-compatible frontmatter and slugs
- **`navigation.yml`** for Fern docs structure
## Acknowledgments
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.
## Development
All configuration is mainly in `pyproject.toml`.
Use [tox](https://tox.readthedocs.io/en/latest/) to run the tests.
```bash
pipx install tox
tox -av
```
Use [pre-commit](https://pre-commit.com/) to run the linters and formatters.
```bash
pipx install pre-commit
pre-commit run --all-files
# pre-commit install
```
[flit](https://flit.readthedocs.io/en/latest/) is used to build the package.
```bash
pipx install flit
flit build
```
Raw data
{
"_id": null,
"home_page": null,
"name": "py2fern",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "python, documentation, fern, api, static-analysis",
"author": null,
"author_email": "Ryan Stephen <ryanstep@buildwithfern.com>",
"download_url": "https://files.pythonhosted.org/packages/58/3e/5828d92ee102ab987f4650dffe0e82cc91e1a4a667ffc2780dc85b5807c8/py2fern-0.1.2.tar.gz",
"platform": null,
"description": "# py2fern\n\nGenerate [Fern](https://buildwithfern.com) API documentation from Python packages using static analysis.\n\nSimplified fork of [`sphinx-autodoc2`](https://github.com/sphinx-extensions2/sphinx-autodoc2) focused purely on **Python \u2192 Fern markdown** output.\n\n## Installation\n\n```bash\npipx install py2fern\n```\n\n## Usage\n\nGenerate Fern markdown documentation:\n\n```bash\npy2fern write /path/to/your/package\n```\n\nSpecify output directory:\n\n```bash\npy2fern write /path/to/your/package --output ./docs/api\n```\n\nThis creates:\n- **MDX files** with Fern-compatible frontmatter and slugs\n- **`navigation.yml`** for Fern docs structure \n\n## Acknowledgments\n\nThis 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.\n\n## Development\n\nAll configuration is mainly in `pyproject.toml`.\n\nUse [tox](https://tox.readthedocs.io/en/latest/) to run the tests.\n\n```bash\npipx install tox\ntox -av\n```\n\nUse [pre-commit](https://pre-commit.com/) to run the linters and formatters.\n\n```bash\npipx install pre-commit\npre-commit run --all-files\n# pre-commit install\n```\n\n[flit](https://flit.readthedocs.io/en/latest/) is used to build the package.\n\n```bash\npipx install flit\nflit build\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Generate Fern documentation from Python packages using static analysis.",
"version": "0.1.2",
"project_urls": {
"Home": "https://github.com/fern-api/py2fern"
},
"split_keywords": [
"python",
" documentation",
" fern",
" api",
" static-analysis"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ba4270be961e24b7aa520b96f8ef00e7dc416124e786aa878da1f7982b62d944",
"md5": "b4885b895cb6908b57939c86da48cf33",
"sha256": "51c4592e2561296b4f3603043c76e9bb60508e95183a3211a24006d830c139b0"
},
"downloads": -1,
"filename": "py2fern-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b4885b895cb6908b57939c86da48cf33",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 34836,
"upload_time": "2025-11-03T01:09:15",
"upload_time_iso_8601": "2025-11-03T01:09:15.360870Z",
"url": "https://files.pythonhosted.org/packages/ba/42/70be961e24b7aa520b96f8ef00e7dc416124e786aa878da1f7982b62d944/py2fern-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "583e5828d92ee102ab987f4650dffe0e82cc91e1a4a667ffc2780dc85b5807c8",
"md5": "00586f6caa6d2357c153cfbd58694076",
"sha256": "e699103519ec6ebf4ec354f8872136be047b1f2a574c1559e0bd83c843c75ca8"
},
"downloads": -1,
"filename": "py2fern-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "00586f6caa6d2357c153cfbd58694076",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 38898,
"upload_time": "2025-11-03T01:09:16",
"upload_time_iso_8601": "2025-11-03T01:09:16.488180Z",
"url": "https://files.pythonhosted.org/packages/58/3e/5828d92ee102ab987f4650dffe0e82cc91e1a4a667ffc2780dc85b5807c8/py2fern-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-03 01:09:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fern-api",
"github_project": "py2fern",
"github_not_found": true,
"lcname": "py2fern"
}
