sphinx-serve 1.0.1

Preview sphinx documentation locally

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