Skip to main content

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.

Source Distribution

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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

Details for the file phix-0.6.1.tar.gz.

File metadata

  • Download URL: phix-0.6.1.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for phix-0.6.1.tar.gz
Algorithm Hash digest
SHA256 6e2989113dc89887a207ff8920c2bead3f96f03aeb5c1554e8a83e5ad0098687
MD5 a6bc6052072254174418adba4d7e9c3d
BLAKE2b-256 e60189724ee9362de82903e2182b2037dcc875be59f1889a0ad1714a0073e936

See more details on using hashes here.

File details

Details for the file phix-0.6.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for phix-0.6.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5ba08daa7c2d3d6cb1212c92c76d8545fbae226c1dc3810437e59ddf4f0b4b62
MD5 68a25a0c1ac9156f5d7ff6204865e991
BLAKE2b-256 101ce82cfb53c40b84f0021ad1dcb98a46af825d1b962cb3e95101ccbc6479c1

See more details on using hashes here.

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