Metadata-Version: 2.1
Name: phink
Version: 0.1.0
Summary: Phink provides a convenient wrapper around Sphinx to make project documentation a breeze.
Home-page: https://github.com/sneakypete81/clickshot
License: GPL-3.0
Keywords: documentation,sphinx,readthedocs
Author: sneakypete81
Author-email: sneakypete81@gmail.com
Requires-Python: >=3.6,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Sphinx
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing :: Markup :: HTML
Requires-Dist: livereload (>=2.6,<3.0)
Requires-Dist: recommonmark (>=0.6.0,<0.7.0)
Requires-Dist: sphinx (>=2.2,<3.0)
Requires-Dist: sphinx_rtd_theme (>=0.4.3,<0.5.0)
Project-URL: Repository, https://github.com/sneakypete81/clickshot
Description-Content-Type: text/markdown

# Phink

<!--
This `README.md` file was autogenerated by **Phink**.
You can replace it with a description of your project.

This file is saved to your root project directory and symlinked into the `doc/` directory.
-->

**Phink** provides a convenient wrapper around [Sphinx](http://www.sphinx-doc.org) to make project documentation a breeze.

* Super easy to setup and build
* Write your docs in [Markdown](https://recommonmark.readthedocs.io)
* Automatically [rebuild and reload](https://livereload.readthedocs.io) during development
* Extract docstrings for [API documentation](http://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html)

## Installation
```sh
    pip install phink
```

## Getting Started

**Create** a set of sample documentation files:

```sh
    cd your_project_directory
    phink init
```

**Build** and serve the HTML output:

```sh
    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](https://docs.readthedocs.io/en/stable/intro/import-guide.html).

