easyise / docblock2web

Generate Markdown from your phpDocs/jsDocs (written in Python)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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.

About

Generate Markdown from your phpDocs/jsDocs (written in Python)


Languages

Language:Python 66.7%Language:Jupyter Notebook 29.3%Language:PHP 4.0%