Skip to main content

Make writing your Sphinx docs a little easier.

Project description

author: Kit La Touche


Make writing your Sphinx docs a little easier.

This is a command line tool to build and serve your Sphinx docs. Run this from inside the directory where your Sphinx Makefile is, and it will build your docs on any *.rst change, and serve them at http://localhost:8000.


  • -t, --type: the make subcommand to run, and the _build subdirectory to serve. Defaults to dirhtml.

  • -p, --port: the port to serve the docs on. Defaults to 8000.

  • -r, --root: the root directory of the Sphinx project to build and serve. Defaults to ..

  • --help: Show the help.

  • --version: Show the version.

Installation / Usage

To install use pip:

$ pip install phix

Or clone the repo:

$ git clone
$ python install

Then run it:

$ phix


Fork it, make a PR, and I’ll take a look!

Project details

Download files

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

Source Distribution

phix-0.6.1.tar.gz (4.1 kB view hashes)

Uploaded source

Built Distribution

phix-0.6.1-py2.py3-none-any.whl (5.0 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page