Metadata-Version: 2.5
Name: sphinx-vitepress
Version: 0.1.1
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
License-File: NOTICE.md
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: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Documentation
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: sphinx-markdown-builder<0.7,>=0.6.10
Requires-Dist: sphinx>=7.0
Description-Content-Type: text/markdown

# sphinx-vitepress

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).

**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

```bash
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:

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

## License

MIT. See [LICENSE](LICENSE) and [NOTICE.md](NOTICE.md).
