sphinx-vitepress

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

Documentation: https://www.rohandahale.com/sphinx-vitepress/ (built with this package).

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

sphinx-vitepress build docs produces a complete VitePress site: markdown, generated config, theme, and objects.inv. The documentation is itself built this way, so the site you read is the output of the tool it describes.

Quick start

pip install sphinx-vitepress          # not yet published; use a git checkout
sphinx-vitepress init docs            # or point it at an existing docs/ dir
sphinx-vitepress dev docs             # live preview
sphinx-vitepress build docs _site     # production build

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

Configuration

All settings are optional; html_logo, html_favicon and copyright are picked up from your existing Sphinx config.

Setting	Purpose
`vitepress_repo`	GitHub icon in the navbar and per-page edit links
`vitepress_accent`	accent palette: a preset (`blue`, `afmhot`, `viridis`, `plasma`, `inferno`, `magma`, `cividis`, `ocean`), a hex color, four hex stops, or `{"light": …, "dark": …}`
`vitepress_frontmatter`	per-page VitePress frontmatter. Use `{"index": {"layout": "home", "hero": {...}}}` for a hero landing page
`vitepress_docstring_style`	`"details"` (collapsible API cards, default) or `"headings"`
`vitepress_inline_toctree`	keep Sphinx's inline toctree lists (off by default; the sidebar already has them)
`vitepress_base`, `vitepress_title`, `vitepress_description`	site basics

Versioned deploys:

sphinx-vitepress deploy docs --deploy-dir _site --release v1.2.3 --repo-base /my-repo/

License

MIT. See LICENSE and NOTICE.md.

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.0.tar.gz (106.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.0-py3-none-any.whl (35.6 kB view details)

Uploaded Aug 14, 2026 Python 3

File details

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

File metadata

Download URL: sphinx_vitepress-0.1.0.tar.gz
Upload date: Aug 14, 2026
Size: 106.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.0.tar.gz
Algorithm	Hash digest
SHA256	`69513d93251ce5125f844abea185874b54a7b7a4568f82412bfac394784becab`
MD5	`f54655290fa011394cd8592451f73298`
BLAKE2b-256	`16efce6e1efee61268c5c14d6431c828ddf9606aa686f991f306a1daf91687b5`

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_vitepress-0.1.0.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.0.tar.gz
- Subject digest: 69513d93251ce5125f844abea185874b54a7b7a4568f82412bfac394784becab
- Sigstore transparency entry: 2468848845
- Sigstore integration time: Aug 14, 2026
Source repository:
- Permalink: rohandahale/sphinx-vitepress@8eaa02f4a26dcdec37ead5feddbf37a2937cc433
- Branch / Tag: refs/tags/v0.1.0
- Owner: https://github.com/rohandahale
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@8eaa02f4a26dcdec37ead5feddbf37a2937cc433
- Trigger Event: push