Phink

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

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.

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution for phink 0.2.0
File	Size	Uploaded
phink-0.2.0.tar.gz	17.6 kB	Nov 30, 2019	Details

Table of built distributions (wheels) for phink 0.2.0
File	Interpreter	ABI	Platform	Reset
phink-0.2.0-py3-none-any.whl 20.9 kB Nov 30, 2019	Python 3	none	any	Details

Total release size: 38.5 kB

Download URL	phink-0.2.0.tar.gz
Size	17.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`67a27d3c2df729322f07f9777940f2eec5f9402e4f39233b71d297d04b3183bd`
BLAKE2b-256 checksum How to use checksums	`a24403f9fef9a21680b7217fb9484dd29b9ce1177a9d75c47df41d19778bcf2b`
Upload date	Nov 30, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/0.12.17 CPython/3.6.7 Linux/4.15.0-1028-gcp`

Download URL	phink-0.2.0-py3-none-any.whl
Size	20.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`88700b17a37e824a0d6d6f2166fbdf18d8902b7f077cc7c53f519f2057054be2`
BLAKE2b-256 checksum How to use checksums	`8afe8610ee4d371454a2948335153993cfd858c2a5df107e7fbffba14a06f5ce`
Upload date	Nov 30, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/0.12.17 CPython/3.6.7 Linux/4.15.0-1028-gcp`