Skip to content
New issue

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

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

Already on GitHub? # to your account

Markdown tables not rendered as tables #64

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

Markdown tables not rendered as tables #64

mikecharles opened this issue Aug 27, 2015 · 5 comments

Comments

@mikecharles
Copy link

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
Copy link
Author

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
Copy link
Contributor

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
Copy link
Author

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
Copy link

+1 for tables...

maybe a pluggable rendering engine would be nice??

@cortesi
Copy link
Member

cortesi commented Jun 3, 2018

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

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants