Skip to main content

Parses PHP doc blocks into markdown

Project description

https://badge.fury.io/py/parsedoc.png https://travis-ci.org/thomwiggers/parsedoc.png?branch=master Download format License Supported Python versions Supported Python implementations

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.2.1 (2018-3-5)

  • Declare that we support more recent versions of Python
  • Fix shields in README.rst

0.2.0 (2014-11-16)

  • Adds --no-output mode
  • Allow to pass input via stdin
  • Add example git update hook

0.1.1 (2014-11-16)

  • Bugfix in the filter plugin
  • Minor bugfixes with logging statements

0.1.0 (2014-10-3)

  • First release on PyPI.

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
parsedoc-0.2.1-py2.py3-none-any.whl (34.4 kB) Copy SHA256 hash SHA256 Wheel 3.6 Mar 5, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page