Phink provides a convenient wrapper around Sphinx to make project documentation a breeze.
Project description
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.
Release history Release notifications
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
| Filename, size | File type | Python version | Upload date | Hashes |
|---|---|---|---|---|
| Filename, size phink-0.2.0-py3-none-any.whl (20.9 kB) | File type Wheel | Python version py3 | Upload date | Hashes View hashes |
| Filename, size phink-0.2.0.tar.gz (17.6 kB) | File type Source | Python version None | Upload date | Hashes View hashes |
