pdoc

pdoc copied to clipboard

Couldn't read PEP-224 variable docstrings from x

6

### Expected Behavior pdoc3 ignores .py files without docstrings. ### Actual Behavior pdoc3 throws a UserWarning exception "Couldn't read PEP-224 variable docstrings from ..." ### Steps to Reproduce 1. run...

timkofu

Code blocks broken inside markdown `!!! note` admonitions

1

### Expected Behavior Markdown is parsed properly ### Actual Behavior Weird behavior happens or wrong language gets parsed ### Steps to Reproduce 1. Have a `!!! note` with a codeblock...

davfsa

Unable to get argument checking to work?

1

Pdoc3's homepage indicates the argument checking works. I took this function: ``` def mdy_to_ymd_str(mdy): """ Convert from mm/dd/yyyy datetime date string to a yyyy-mm-dd string. Args: mdy: The DateTime date...

bschollnick

This issue is probably the same as #30 which was closed "invalid". Here are steps to reproduce. It looks like an interaction (name collision) between "pdoc" and "pdoc3" packages. Both...

rodanrider

Module-level docstring section name disrupts parsing of class code

3

### Expected Behavior When dealing with docstrings at the module level and the class level, `pdoc3` should include the valid source code for the class in the rendered HTML, regardless...

cheshyre

classmethods documented as a static method

3

### Expected Behavior  ### Actual Behavior  ### Steps to Reproduce Example code: ``` import documentation_test.submod1.submod1 as submod1 import documentation_test.submod2.submod2 as submod2 __all__ = ['testFunction', 'testClass'] class testClass(object): """Summary...

dmot7291

Programmatic way of showing module list

1

### Expected Behavior As per #91. It's not immediately obvious how one could generate a list of modules programmatically. It looks like your mako template changes format based on context:...

stevegore