Parses PHP doc blocks into markdown
Project description
Parses PHP doc blocks into markdown
Usage
See parsedoc --help.
Features
Parse PHP files into markdown
Able to recursively do this for a folder
Create index files per folder
Allows to only include certain annotations
Allows to not write files without comments
Requirements
Python >= 2.7 or >= 3.3
Also tested using PyPy
docopt
Installation
pip install . or python setup.py install.
Licence
Copyright (C) 2014 Thom Wiggers
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
See the bundled LICENCE file for more details.
History
0.1.0 (2014-10-3)
First release on PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for parsedoc-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7af3804dda48183c263e8781178f1910a30bc20ba9aa8d19884acddf931f65e |
|
MD5 | 9fcffe1c74b6ca636ffc96c528f72383 |
|
BLAKE2b-256 | 1ca377e5d29ad3eb16a3b2f040085790c74c825194e339793f12dcaadba51ce5 |