Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 

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.

About

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

Resources

Releases

No releases published

Packages

No packages published