https://github.com/wlonk/phix
Make writing your Sphinx docs a little easier.
https://github.com/wlonk/phix
documentation restructuredtext sphinx
Last synced: about 1 year ago
JSON representation
Make writing your Sphinx docs a little easier.
- Host: GitHub
- URL: https://github.com/wlonk/phix
- Owner: wlonk
- License: mit
- Created: 2017-08-14T17:46:53.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-06-12T02:55:42.000Z (about 8 years ago)
- Last Synced: 2025-03-23T20:11:18.416Z (over 1 year ago)
- Topics: documentation, restructuredtext, sphinx
- Language: Python
- Homepage: https://pypi.python.org/pypi/phix
- Size: 23.4 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.md
Awesome Lists containing this project
README
====
phix
====
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!