Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Make writing your Sphinx docs a little easier.

Project description

author: Kit La Touche

Overview

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.

Options:

  • -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 https://github.com/wlonk/phix.git
$ python setup.py install

Then run it:

$ phix

Contributing

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.

Files for phix, version 0.6.1
Filename, size File type Python version Upload date Hashes
Filename, size phix-0.6.1-py2.py3-none-any.whl (5.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size phix-0.6.1.tar.gz (4.1 kB) File type Source Python version None Upload date Hashes View hashes

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