phink 0.2.0

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

Phink

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

• Super easy to setup and build
• Write your docs in Markdown
• Automatically rebuild and reload during development
• Extract docstrings for API documentation

Read the full Phink documentation to learn more.

Installation

    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.