Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown tables not rendered as tables #64

Closed
mikecharles opened this issue Aug 27, 2015 · 5 comments

Comments

Projects
None yet
4 participants
@mikecharles
Copy link

commented Aug 27, 2015

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

This comment has been minimized.

Copy link
Author

commented Aug 27, 2015

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

This comment has been minimized.

Copy link
Contributor

commented Aug 27, 2015

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

This comment has been minimized.

Copy link
Author

commented Aug 27, 2015

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...

@robmoggach

This comment has been minimized.

Copy link

commented Jan 10, 2016

+1 for tables...

maybe a pluggable rendering engine would be nice??

@cortesi

This comment has been minimized.

Copy link
Member

commented Jun 3, 2018

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

@cortesi cortesi closed this Jun 3, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.