Skip to main content

Preview sphinx documentation locally

Project description


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.


pip install sphinx-serve


Run with:


For all available options use:

sphinx-serve –help

Project details

Download files

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

Files for sphinx-serve, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size sphinx-serve-1.0.1.tar.gz (2.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page