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!
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file phix-0.3.1.tar.gz.
File metadata
- Download URL: phix-0.3.1.tar.gz
- Upload date:
- Size: 3.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 27cc800ea326a5397c28c8610e3b588059cb1f5d6ae704230a915e74a51f6db8 |
|
| MD5 | 7562572c13081a618339bdf66d8f5d14 |
|
| BLAKE2b-256 | 7be7a8aa05d595daef85d4922154fae52a6375c9295738c8e5c2be4bcebb0475 |
File details
Details for the file phix-0.3.1-py2.py3-none-any.whl.
File metadata
- Download URL: phix-0.3.1-py2.py3-none-any.whl
- Upload date:
- Size: 4.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 005ae9405fee7eb067eba91837b15968b4f761846f72784310af8ae87b51041e |
|
| MD5 | 42e540660cec1f18d4f1c3e07482115c |
|
| BLAKE2b-256 | b9359fe67c5803922a81e8d71089f2a47880c30ec714619475b7a2fc7d72cd4b |
