Docusaurus renderer

[m-vdb]

Fixes #147

Proposed changes

• add options on the default MarkdownRenderer:
  • escape_html_in_docstring
  • render_module_header_template
  • skip_empty_modules
• create a DocusaurusRenderer class that can generate multiple markdown files
• add end-to-end tests for the functionality

[m-vdb]

@NiklasRosenstein here it is! I'd appreciate a review 😄

[m-vdb]

thanks for your review 👍

[m-vdb]

@NiklasRosenstein

• Could you implement a pydoc-markdown --bootstrap docusaurus option to the CLI?

Done in fb2c8f9 ✅

• Could we have the Docusaurus renderer implement the Builder and Server interface (in order to build the documentation through pydoc-markdown or start a live-preview of the docs)?
• Would it make sense to add a pages attribute like the Hugo and Mkdocs renderer have (to allow specifying files and their contents rather than having to rely on the exact structure as pre-defined by the renderer)?

So I think both of these conceptually make sense, but we do not really rely on them in our setup. Basically, we're using pydoc-markdown to generate documentation from the code and output it in the right structure. Separately, we have our docusaurus set up that simply picks up the generated files and includes them in a much bigger site. Does that make sense? I do not think I would have time to implement the whole thing sadly 🤷

Other than that, I think I answered all of your comments ✅

[NiklasRosenstein]

Thanks @m-vdb !

Gotcha, after looking a bit more into Docusaurus it looks like it depends a lot on a bunch of bootstrapped files and some configuration changes are necessary after generating the files with Pydoc-Markdown. While I would still prefer an (optional) low-configuration solution for using Docusaurus + Pydoc-Markdown, it looks like quite a bit of work for now. I'll maybe look into this at a later point though 👍

[m-vdb]

amazing @NiklasRosenstein thanks a lot for merging this in! Can you let me know when you release these, so that we can update the package we rely on in Rasa ? 🙏 🚀

[NiklasRosenstein]

You're in 3.5.0 🚀

Thanks again for the contribution!

[m-vdb]

amazing! you're very much welcome!