NiklasRosenstein / pydoc-markdown

Create Python API documentation in Markdown format.
http://niklasrosenstein.github.io/pydoc-markdown/
Other
459 stars 102 forks source link

Default markdown config broken #118

Closed tbm closed 4 years ago

tbm commented 4 years ago

After pydoc-markdown --bootstrap I get:

  File "/home/tbm/.local/lib/python3.7/site-packages/nr/databind/core/__init__.py", line 476, in deserialize_node
    node.result = deserializer.deserialize(self, node)
  File "/home/tbm/.local/lib/python3.7/site-packages/nr/databind/json/serializers.py", line 598, in deserialize
    raise node.type_error()
nr.databind.core.SerializationTypeError: in "pydoc-markdown.yml": at $.renderer: expected "UnionType", got "list"

Changing:

renderer:
  - type: markdown

to:

renderer:
  type: markdown

makes it work but imho it would be good to keep backwards compatibility.

NiklasRosenstein commented 4 years ago

Thanks for flagging this, fixed it. Will be in 3.0.3

NiklasRosenstein commented 4 years ago

Actually 3.1.0 -- be sure to check out the changelog: https://niklasrosenstein.github.io/pydoc-markdown/changelog/