sphinx-vitepress

A Sphinx builder that renders your documentation with VitePress. It is the Python counterpart of DocumenterVitepress.jl.

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

Install

pip install sphinx-vitepress

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

Use

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, which is itself built with this package.

License

MIT. See LICENSE, which also carries the notices for the MIT-licensed projects this one adapts code from.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_vitepress-0.1.5.tar.gz (116.5 kB view details)

Uploaded Aug 14, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

sphinx_vitepress-0.1.5-py3-none-any.whl (39.5 kB view details)

Uploaded Aug 14, 2026 Python 3

File details

Details for the file sphinx_vitepress-0.1.5.tar.gz.

File metadata

Download URL: sphinx_vitepress-0.1.5.tar.gz
Upload date: Aug 14, 2026
Size: 116.5 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for sphinx_vitepress-0.1.5.tar.gz
Algorithm	Hash digest
SHA256	`11d389b1240f44ad44bd211abe89e78080a37b523af48df84dd84a1fc54bf8d2`
MD5	`0556e414637e9887174dc867110f5716`
BLAKE2b-256	`8cb08af194aab6cf2f49b1af4a0d82c859d74999eac2a7a895a83b30b22135ca`

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_vitepress-0.1.5.tar.gz:

Publisher: release.yml on rohandahale/sphinx-vitepress

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: sphinx_vitepress-0.1.5.tar.gz
- Subject digest: 11d389b1240f44ad44bd211abe89e78080a37b523af48df84dd84a1fc54bf8d2
- Sigstore transparency entry: 2469445749
- Sigstore integration time: Aug 14, 2026
Source repository:
- Permalink: rohandahale/sphinx-vitepress@10d1011b1588c240138e87c8b66312afd4e809fa
- Branch / Tag: refs/tags/v0.1.5
- Owner: https://github.com/rohandahale
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@10d1011b1588c240138e87c8b66312afd4e809fa
- Trigger Event: push