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.6.0.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

phix-0.6.0-py2.py3-none-any.whl (4.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for phix-0.6.0.tar.gz
Algorithm Hash digest
SHA256 c62d40661b2738e1cb77dc074b25c43fc157d802c69699510a67150329152d92
MD5 3b13e1c02dc3be8062f25b3cfb74d5a1
BLAKE2b-256 ad6221b66ec7d84f508f1d5dcc57684eb4ce0c838b9c07a1bdaeba070f7be10a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for phix-0.6.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e51a8417481b96488226a1ec10367213273e078133b720fbb0f1bfa5b1ba02d6
MD5 33e06af4594c9e02e89b026d30281ad4
BLAKE2b-256 2691ccd9ef90997d74db1e0c030b18c114f4da52cd38a69311be5124fd7d5a10

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