draft: generate reference documentation using mkdosctrings

[erikkristoferanderson]

trafficstars

This draft PR shows my work so far on automatically generating a reference section of the documentation based on docstrings in the source code.

I find that mkdosctrings may not be a sufficient tool for this task because it seems more optimized towards documenting individual functions or modules, rather than a full library. I will continue to research and try to understand how projects like interactions.py and Serenity generate their documentation.

Note: I adjusted the available Python versions for compatibility with the new documentation dependencies. I understand this may pose an issue.

References

• interactions.py API reference
• Serenity documentation

Submitter checklist

• [x] The PR request is well described and justified, including the body and the references
• [?] The PR title represents the desired changelog entry
• [-] The repository's code style is followed (see the contributing guide)
• [-] Test coverage that demonstrates that the change works as expected
• [-] For new features, there's necessary documentation in this pull request or in a subsequent PR to wiremock.org

[oleg-nenashev]

Sorry, I missed that PR. Added to my list

[oleg-nenashev]

It is a good start anyway. Worst case we could attach code docs as a generated HTML