How to force functions into TOC?

NiklasRosenstein / pydoc-markdown

Create Python API documentation in Markdown format.

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

Other

458 stars 102 forks source link

How to force functions into TOC? #176

Closed NoahCardoza closed 3 years ago

NoahCardoza commented 3 years ago

I've been looking over the docs and I'm trying to get the table of contents to list functions, not just classes. Is this possible?

NoahCardoza commented 3 years ago

Writing this got e thinking and I noticed it wasn't based on the fact that it's a function, it was based on the title level. I as able to achive what I wanted by setting:

renderer:
    markdown:
        header_level_by_type:
           Function: 2

I hope this helps someone in the future!