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

These details have not been verified by PyPI

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Project description

Phink

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

Read the full Phink documentation to learn more.

    pip install phink

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.

These details have not been verified by PyPI

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

This version

0.2.0

Nov 30, 2019

0.1.0

Nov 29, 2019

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Uploaded Nov 30, 2019 Source

Uploaded Nov 30, 2019 Python 3

Hashes for phink-0.2.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`88700b17a37e824a0d6d6f2166fbdf18d8902b7f077cc7c53f519f2057054be2`
MD5	`344c3b0f1efd603731a31ea8319047e1`
BLAKE2b-256	`8afe8610ee4d371454a2948335153993cfd858c2a5df107e7fbffba14a06f5ce`