PyPI Build Status Documentation Status

Phink provides a convenient wrapper around Sphinx to make project documentation a breeze.

Read the full Phink documentation to learn more.


    pip install phink

Getting Started

Create a set of sample documentation files:

    cd your_project_directory
    phink init

Build and serve the HTML output:

    phink serve

Edit the files in the doc/ directory to your liking. The documentation will be rebuilt and reloaded automatically in your browser.

Commit and push to your Git repository. Make sure you don’t commit the doc/_build directory.

Publish to ReadTheDocs by following the RTD import documentation.