Skip to main content

sphinx-serve

Simple utility to easier preview your sphinx documentation.

After running the sphinx-serve command, it tries to detect the sphinx build directory. It examines the current working directory and if the build directory is not present, it tries to iterate the parent paths. If a build directory is detected it launches an http server.

The build directory name is configurable. It also supports serving documentation from the html folder of the singlehtml folder.

Installation

pip install sphinx-serve

Usage

Run with:

sphinx-serve

For all available options use:

sphinx-serve –help

Metadata

Release files for sphinx-serve 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-serve 1.0.1
File Size Uploaded
sphinx-serve-1.0.1.tar.gz 2.5 kB Details

Release files / sphinx-serve-1.0.1.tar.gz

Download URL sphinx-serve-1.0.1.tar.gz
Size 2.5 kB
Tags Source
SHA-256 checksum
How to use checksums
8d90f6595114108500b1f935d3f4d07bf5192783c67ce83f944ef289099669c9
BLAKE2b-256 checksum
How to use checksums
6b6c4e92f63609a489898d6b257aa721a844416468a3121febef9ae8a0be531e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

1.0.1 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page