Metadata-Version: 2.5
Name: sphinx-vitepress
Version: 0.1.5
Summary: A Sphinx builder that renders your documentation with VitePress.
Project-URL: Homepage, https://github.com/rohandahale/sphinx-vitepress
Project-URL: Documentation, https://www.rohandahale.com/sphinx-vitepress/
Project-URL: Repository, https://github.com/rohandahale/sphinx-vitepress
Project-URL: Changelog, https://github.com/rohandahale/sphinx-vitepress/blob/main/CHANGELOG.md
Project-URL: Issues, https://github.com/rohandahale/sphinx-vitepress/issues
Author-email: Rohan Dahale <astrorohandahale@gmail.com>
License-Expression: MIT
License-File: LICENSE
Keywords: autodoc,builder,documentation,markdown,sphinx,vitepress
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Documentation
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: docutils>=0.20
Requires-Dist: myst-parser>=2.0
Requires-Dist: sphinx-markdown-builder<0.7,>=0.6.10
Requires-Dist: sphinx>=7.0
Description-Content-Type: text/markdown

# sphinx-vitepress

[![docs stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://www.rohandahale.com/sphinx-vitepress/stable/)
[![docs dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://www.rohandahale.com/sphinx-vitepress/dev/)
[![CI](https://github.com/rohandahale/sphinx-vitepress/actions/workflows/ci.yml/badge.svg)](https://github.com/rohandahale/sphinx-vitepress/actions/workflows/ci.yml)
[![PyPI](https://img.shields.io/pypi/v/sphinx-vitepress.svg)](https://pypi.org/project/sphinx-vitepress/)
[![Python](https://img.shields.io/pypi/pyversions/sphinx-vitepress.svg)](https://pypi.org/project/sphinx-vitepress/)
[![License](https://img.shields.io/pypi/l/sphinx-vitepress.svg)](https://github.com/rohandahale/sphinx-vitepress/blob/main/LICENSE)

A Sphinx builder that renders your documentation with [VitePress](https://vitepress.dev).
It is the Python counterpart of
[DocumenterVitepress.jl](https://github.com/LuxDL/DocumenterVitepress.jl).

Keep your `conf.py`, autodoc, NumPy-style docstrings and intersphinx
cross-references; swap classic Sphinx HTML for a modern VitePress site.

## Install

```bash
pip install sphinx-vitepress
```

Node.js 20 or newer is needed only to run VitePress itself. Generating the
markdown never requires it.

## Use

```bash
sphinx-vitepress init docs         # or point it at an existing docs/ directory
sphinx-vitepress dev docs          # live preview
sphinx-vitepress build docs _site  # production build
```

Existing projects need no changes: autodoc, napoleon, intersphinx and MyST keep
working, and `sphinx-build -b vitepress <src> <out>` works too.

Configuration, versioned deploys and the API are covered in the
[documentation](https://www.rohandahale.com/sphinx-vitepress/), which is itself
built with this package.

## License

MIT. See [LICENSE](https://github.com/rohandahale/sphinx-vitepress/blob/main/LICENSE), which also carries the notices for the
MIT-licensed projects this one adapts code from.
