search

mitmproxy / pdoc

API Documentation for Python Projects
https://pdoc.dev
MIT No Attribution
1.96k stars 194 forks source link

Markdown tables not rendered as tables #64

Closed mikecharles closed 6 years ago

mikecharles commented 9 years ago

I'm using the following command:

pdoc test.py --html

to create an API doc for the following Python script:

#!/usr/bin/env python

def test():
    """
    Test function

    | Tables        | Are           | Cool  |
    | ------------- |:-------------:| -----:|
    | col 3 is      | right-aligned | $1600 |
    | col 2 is      | centered      |   $12 |
    | zebra stripes | are neat      |    $1 |
    """
    pass

Here's the resulting HTML:

issue

Shouldn't pdoc handle any standard markdown syntax?

mikecharles commented 9 years ago

Sorry, nevermind, I didn't even realize tables were not a part of standard Markdown. Would it be easy to add it with this?

BurntSushi commented 9 years ago

I generally like Github's version of Markdown, so I wouldn't mind swapping what we have for that.

However, I think my strongest preference would be for CommonMark. Does that have tables?

mikecharles commented 9 years ago

Seems like many people don't think tables should even be part of the core spec for Markdown in version 1.0, so it's probably far off...

rjmoggach commented 8 years ago

+1 for tables...

maybe a pluggable rendering engine would be nice??

cortesi commented 6 years ago

Please see #153 for a unified discussion ticket about docstring flavors.