Skip to main content

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

Project description

Phink

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.

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.

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

phink-0.2.0.tar.gz (17.6 kB view hashes)

Uploaded source

Built Distribution

phink-0.2.0-py3-none-any.whl (20.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page