Is there a way to modify the output such that functions do not show?

NiklasRosenstein / pydoc-markdown

Create Python API documentation in Markdown format.

http://niklasrosenstein.github.io/pydoc-markdown/

Other

458 stars 102 forks source link

Is there a way to modify the output such that functions do not show? #164

Closed grantcurell closed 3 years ago

grantcurell commented 3 years ago

Just out of curiosity, is there a way to make it so that functions in each file do not render?

Also - awesome project! Much appreciated!

NiklasRosenstein commented 3 years ago

Hey @grantcurell ,

I'm glad you like it. :)

You can use a filter processor and supply an expression that excludes API objects of type Function.

processors:
- type: filter
  expression: default() and type(obj).__name__ != 'Function'

Lmk if that works for you.

Cheers,

grantcurell commented 3 years ago

I feel super guilty - I appreciate the help, but I ended up needing enough customization that I ended up just rolling a Jinja2 template. (I had some weird circumstances.) Apologies for putting you out of your way.