HTML generation / carriage return lost for multi-lines docstring

[shazz]

Hi,
I'm uisng the PEP 287 -- reStructuredText Docstring Format for my documentation like:

"""
This is a reST style.

:param param1: this is a first param
:param param2: this is a second param
:returns: this is a description of what is returned
:raises keyError: raises an exception
"""

and when generating the HTML pdoc, all the lines are merged in one long line instead of n lines (unless I had '\n' at the end of each line but...)

Thanks !

[kernc]

Duplicate of #153.

[armant]

Please also note "Equally, I feel we should clearly not include support for reStructuredText, which is way too large and complicated." in #153.

[KyleKing]

What is the default Markdown style supported by pdoc?

Something like the below is garbled into one line. Adding two trailing spaces to each line works to force the line breaks, but requiring two spaces is unmaintainable and would conflict with remove trailing whitespace

def chooseBest(self, img, circles, manuallyAlign=True):
    """Return the circle with the best fit based on a multi-step procedure.

    img -- Numpy array
    circles -- List of tuples (x, y, r)
    manuallyAlign -- If True, implement the manual alignment step. Otherwise return best programmatic match

    """
    return

[armant]

What is the default Markdown style supported by pdoc?

Something like the below is garbled into one line. Adding two trailing spaces to each line works to force the line breaks, but requiring two spaces is unmaintainable and would conflict with remove trailing whitespace

def chooseBest(self, img, circles, manuallyAlign=True):
    """Return the circle with the best fit based on a multi-step procedure.

    img -- Numpy array
    circles -- List of tuples (x, y, r)
    manuallyAlign -- If True, implement the manual alignment step. Otherwise return best programmatic match

    """
    return

Personally, I hacked around this in css.mako:
p, pre { white-space: pre-wrap; }

[KyleKing]

Haha, I was trying to do the same since that's the easiest fix, but on my computer pdoc isn't recognizing the --template-dir argument nor the ~/.config/pdoc/* (#178). How did you set up your custom templates?

[armant]

That's weird,
pdoc *module_name* --html --overwrite --template-dir */path/to/template* --html-dir */path/to/html*
works for me.

[KyleKing]

Hmm, that doesn't work for me. Maybe it's a Windows issue? I don't want to hijack this issue, so I'll post any follow up to #178

Update: just a filename issue, see: #178 (comment)