Add option to Render the heading#1 for letting readthedocs to generate TOC automatically #214

NiklasRosenstein / pydoc-markdown

Create Python API documentation in Markdown format.

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

Other

453 stars 102 forks source link

Add option to Render the heading#1 for letting readthedocs to generate TOC automatically #214 #216

Closed t6847kimo closed 2 years ago

t6847kimo commented 2 years ago

Hi, sorry for late response. Please take a look at it, thanks!

NiklasRosenstein commented 2 years ago

I just noticed that I even suggested this 🥲

There's many was this could be done. I think I would prefer an option in the Mkdocs renderer like render_page_title and that option is either passed to Page.render() or is set as an option in the Markdown renderer along with the title string.

t6847kimo commented 2 years ago

Hi, may I know the current status? Can I help anything?

NiklasRosenstein commented 2 years ago

Hey @t6847kimo , sorry for the long silence. I've made a few changes before merging, that's why I create a new PR for it. Thanks for the contribution!