search

NiklasRosenstein / pydoc-markdown

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

Render Markdown Directly #191

Closed reskin89 closed 3 years ago

reskin89 commented 3 years ago

This may not be an issue, but I can't seem to figure out a way to just render Markdown files based on docstrings? It looks like I have to create the pydoc-markdown.yml and use mkdocs to just generate MD files. Is this accurate?

NiklasRosenstein commented 3 years ago

Hey @reskin89 , you can actually specify a YAML config on the command-line as the first argument. You can also rely on the default config and amend it by various command-line flags. For example:

$ pydoc-markdown '{ renderer: { type: markdown } }' -I ./src -m mymodule

(Note that markdown is already the default renderer so the above config is actually superfluous).

NiklasRosenstein commented 3 years ago

Closing due to no response.