Skip to main content

Preview sphinx documentation locally

Project description

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

Project details


Release history Release notifications

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 & hash File type Python version Upload date
sphinx-serve-1.0.1.tar.gz (2.5 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page