Generate Markdown from your phpDocs/jsDocs (written in Python)
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
README.md
docblock2web.ipynb
docblock2web.py
sample.php

README.md

docblock2web

Generate Markdown from your phpDoc/JSDoc inline documentation in simpliest possible way.

Make your code documentation more friendly by publishing it on the web (e.g. on http://github.io).

This tool extracts inline documentation blocks made according to phpDocumentor or JSDoc specifications from your source code file and creates Markdown that could be used with Jekyll, WordPress, WiKi, etc.

Usage example:

from docblock2web import docblock2web

filePath = 'sample.php' 

dbw = docblock2web( open(filePath) )

print( dbw.md() )

Requires Python version 3.