Skip to main content
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.

Release files for parsedoc 0.2.1

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

Built distribution (wheel)

Table of built distributions (wheels) for parsedoc 0.2.1
File Interpreter ABI Platform
parsedoc-0.2.1-py2.py3-none-any.whl Python 3, Python 2 none any Details

Release files / parsedoc-0.2.1-py2.py3-none-any.whl

Download URL parsedoc-0.2.1-py2.py3-none-any.whl
Size 34.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
9d5900b2e07cfdb1cfaae9e4a6aea8b914fe45fdc81d70c310cad965f43f9b67
BLAKE2b-256 checksum
How to use checksums
80718c6e419258b06c8c64fbec5b6a393419976f8d9e885968679d06d0a2fe66
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.2.1 This release

1 release file

0.2.0

3 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page