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.

  • --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.5.0.tar.gz (3.9 kB view details)

Uploaded Source

Built Distribution

phix-0.5.0-py2.py3-none-any.whl (4.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for phix-0.5.0.tar.gz
Algorithm Hash digest
SHA256 5a7df370dcd3e35e5d4d6294e0d7ef42037701fa651e42bfb24764a757d86c3a
MD5 fe442bd283c35ad75b3d30414d0d7e63
BLAKE2b-256 0c8bf1aeb52d2b78c14167d34b0b67a1d01da4f9e142170bb77ffe5411b2bfc3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for phix-0.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ca2bae82a9f79637e79368580f521150f8cfb24a5ba56ed3d3b33e82b72de647
MD5 74206dffac9b2f2e854596455952de5e
BLAKE2b-256 f8279b976c4ada0fba1a767d0da3029fba865a48fae090bd80216424fa558f05

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